Skip to content

bumpversion.config.models ​

Bump My Version configuration models.

logger ​

python
logger = get_indented_logger(__name__)

FileChange ​

python
class FileChange()

A change to make to a file.

get_search_pattern ​

python
def get_search_pattern(context: MutableMapping) -> Tuple[re.Pattern, str]

Render the search pattern and return the compiled regex pattern and the raw pattern.

Parameters

  • context: The context to use for rendering the search pattern

Returns

  • A tuple of the compiled regex pattern and the raw pattern as a string.

Config ​

python
class Config()

Bump Version configuration.

add_files ​

python
def add_files(filename: Union[str, List[str]]) -> None

Add a filename to the list of files.

exclude_configured_files ​

python
def exclude_configured_files() -> None

Exclude all configured files, so only files added later are modified.

resolved_filemap ​

python
resolved_filemap: Dict[str, List[FileChange]]

The cached resolved filemap.

files_to_modify ​

python
files_to_modify: List[FileChange]

A list of files to modify.

version_config ​

python
version_config: VersionConfig

The version configuration.

version_spec ​

python
def version_spec(version: Optional[str] = None) -> VersionSpec

The version specification.

PEP621Info ​

python
class PEP621Info(version: Optional[str])

PEP 621 info, in particular, the static version number.