files

Contains methods for finding and reading configuration files.

Attributes¶

Classes¶

Functions¶

find_config_file ¶

find_config_file(
    explicit_file: Optional[Pathlike] = None,
) -> Union[Path, None]

Find the configuration file, if it exists.

If no explicit configuration file is passed, it will search in several files to find its configuration.

Parameters:

explicit_file

The configuration file to explicitly use.

TYPE: Optional[Pathlike]

DEFAULT: None

Returns:

Union[Path, None]: The configuration file path

get_pep621_info ¶

get_pep621_info(
    config_file: Optional[Pathlike] = None,
) -> Optional[PEP621Info]

Retrieve the PEP 621 project table.

At the moment, only the project.version key is handled. Additionally, if the version is marked as dynamic, then it is explicitly returned as None.

Parameters:

config_file

The configuration file to explicitly use. Per PEP 621, this file must be named pyproject.toml.

TYPE: Optional[Pathlike]

DEFAULT: None

Returns:

Optional[PEP621Info]: A PEP621Info structure, if given a pyproject.toml file to parse, else None.

read_config_file ¶

read_config_file(
    config_file: Optional[Pathlike] = None,
) -> Dict[str, Any]

Read the configuration file, if it exists.

If no explicit configuration file is passed, it will search in several files to find its configuration.

Parameters:

config_file

The configuration file to explicitly use.

TYPE: Optional[Pathlike]

DEFAULT: None

Returns:

Dict[str, Any]: A dictionary of read key-values

read_toml_file ¶

read_toml_file(file_path: Path) -> Dict[str, Any]

Parse a TOML file and return the bumpversion section.

Parameters:

file_path: The path to the TOML file.

TYPE: Path

Returns:

dict: A dictionary of the bumpversion section.

TYPE: Dict[str, Any]

update_config_file ¶

update_config_file(
    config_file: Union[str, Path],
    config: Config,
    current_version: Version,
    new_version: Version,
    context: MutableMapping,
    dry_run: bool = False,
) -> None

Update the current_version key in the configuration file.

Parameters:

config_file

The configuration file to explicitly use.

TYPE: Union[str, Path]

config

The configuration to use.

TYPE: Config

current_version

The current version.

TYPE: Version

new_version

The new version.

TYPE: Version

context

The context to use for serialization.

TYPE: MutableMapping

dry_run

True if the update should be a dry run.

TYPE: bool

DEFAULT: False