From 9bf44a411a41b04b77a67572c9484be25493f896 Mon Sep 17 00:00:00 2001 From: coordt Date: Sat, 27 Jan 2024 14:57:36 +0000 Subject: [PATCH] deploy: 4439fd29c6abfe5e6c2f2246e115e603231fe44c --- _modules/bumpversion/aliases.html | 10 +- _modules/bumpversion/autocast.html | 12 +- _modules/bumpversion/bump.html | 18 +- _modules/bumpversion/config.html | 10 +- _modules/bumpversion/config/files.html | 12 +- _modules/bumpversion/config/files_legacy.html | 10 +- _modules/bumpversion/config/models.html | 38 +- _modules/bumpversion/config/utils.html | 40 +- _modules/bumpversion/exceptions.html | 10 +- _modules/bumpversion/files.html | 17 +- _modules/bumpversion/indented_logger.html | 10 +- _modules/bumpversion/scm.html | 10 +- _modules/bumpversion/show.html | 10 +- _modules/bumpversion/ui.html | 10 +- _modules/bumpversion/utils.html | 12 +- _modules/bumpversion/version_part.html | 316 +--------- .../bumpversion/versioning/conventions.html | 411 ++++++++++++ .../{ => versioning}/functions.html | 166 +++-- _modules/bumpversion/versioning/models.html | 578 +++++++++++++++++ .../bumpversion/versioning/serialization.html | 442 +++++++++++++ _modules/bumpversion/visualize.html | 10 +- _modules/bumpversion/yaml_dump.html | 10 +- _modules/index.html | 15 +- .../bumpversion/bumpversion.bump.md.txt | 2 +- .../bumpversion.config.files.md.txt | 2 +- .../bumpversion.config.models.md.txt | 74 +-- .../bumpversion.config.utils.md.txt | 2 +- .../bumpversion/bumpversion.files.md.txt | 12 +- .../bumpversion/bumpversion.functions.md.txt | 140 ----- .../reference/bumpversion/bumpversion.md.txt | 2 +- .../bumpversion/bumpversion.utils.md.txt | 2 +- .../bumpversion.version_part.md.txt | 166 +---- .../bumpversion.versioning.conventions.md.txt | 132 ++++ .../bumpversion.versioning.functions.md.txt | 168 +++++ .../bumpversion/bumpversion.versioning.md.txt | 20 + .../bumpversion.versioning.models.md.txt | 297 +++++++++ ...umpversion.versioning.serialization.md.txt | 75 +++ changelog.html | 10 +- contributing.html | 10 +- explanation/index.html | 10 +- genindex.html | 208 +++++-- howtos/avoid-incorrect-replacements.html | 10 +- howtos/custom-version-formats-by-file.html | 10 +- howtos/index.html | 10 +- howtos/multiple-replacements.html | 10 +- index.html | 10 +- objects.inv | Bin 5517 -> 5913 bytes py-modindex.html | 46 +- readme.html | 10 +- .../bumpversion/bumpversion.__main__.html | 10 +- .../bumpversion/bumpversion.aliases.html | 10 +- .../bumpversion/bumpversion.autocast.html | 11 +- reference/bumpversion/bumpversion.bump.html | 16 +- reference/bumpversion/bumpversion.cli.html | 10 +- .../bumpversion.config.create.html | 10 +- .../bumpversion/bumpversion.config.files.html | 12 +- .../bumpversion.config.files_legacy.html | 16 +- reference/bumpversion/bumpversion.config.html | 10 +- .../bumpversion.config.models.html | 70 +-- .../bumpversion/bumpversion.config.utils.html | 12 +- .../bumpversion/bumpversion.exceptions.html | 16 +- reference/bumpversion/bumpversion.files.html | 22 +- reference/bumpversion/bumpversion.html | 18 +- .../bumpversion.indented_logger.html | 16 +- reference/bumpversion/bumpversion.scm.html | 10 +- reference/bumpversion/bumpversion.show.html | 10 +- reference/bumpversion/bumpversion.ui.html | 10 +- reference/bumpversion/bumpversion.utils.html | 12 +- .../bumpversion/bumpversion.version_part.html | 164 +---- .../bumpversion.versioning.conventions.html | 447 +++++++++++++ ... => bumpversion.versioning.functions.html} | 120 ++-- .../bumpversion/bumpversion.versioning.html | 349 +++++++++++ .../bumpversion.versioning.models.html | 587 ++++++++++++++++++ .../bumpversion.versioning.serialization.html | 438 +++++++++++++ .../bumpversion/bumpversion.visualize.html | 10 +- .../bumpversion/bumpversion.yaml_dump.html | 16 +- reference/cli.html | 10 +- reference/configuration.html | 10 +- reference/formatting-context.html | 10 +- reference/index.html | 18 +- reference/search-and-replace-config.html | 10 +- reference/version-parts.html | 10 +- search.html | 10 +- searchindex.js | 2 +- tutorials/index.html | 10 +- tutorials/semantic-versioning-example.html | 10 +- usage.html | 10 +- 87 files changed, 4923 insertions(+), 1234 deletions(-) create mode 100644 _modules/bumpversion/versioning/conventions.html rename _modules/bumpversion/{ => versioning}/functions.html (64%) create mode 100644 _modules/bumpversion/versioning/models.html create mode 100644 _modules/bumpversion/versioning/serialization.html delete mode 100644 _sources/reference/bumpversion/bumpversion.functions.md.txt create mode 100644 _sources/reference/bumpversion/bumpversion.versioning.conventions.md.txt create mode 100644 _sources/reference/bumpversion/bumpversion.versioning.functions.md.txt create mode 100644 _sources/reference/bumpversion/bumpversion.versioning.md.txt create mode 100644 _sources/reference/bumpversion/bumpversion.versioning.models.md.txt create mode 100644 _sources/reference/bumpversion/bumpversion.versioning.serialization.md.txt create mode 100644 reference/bumpversion/bumpversion.versioning.conventions.html rename reference/bumpversion/{bumpversion.functions.html => bumpversion.versioning.functions.html} (60%) create mode 100644 reference/bumpversion/bumpversion.versioning.html create mode 100644 reference/bumpversion/bumpversion.versioning.models.html create mode 100644 reference/bumpversion/bumpversion.versioning.serialization.html diff --git a/_modules/bumpversion/aliases.html b/_modules/bumpversion/aliases.html index 69a2ab9d..d212dbdd 100644 --- a/_modules/bumpversion/aliases.html +++ b/_modules/bumpversion/aliases.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/autocast.html b/_modules/bumpversion/autocast.html index de38940e..ebd64722 100644 --- a/_modules/bumpversion/autocast.html +++ b/_modules/bumpversion/autocast.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -245,6 +251,8 @@

    Source code for bumpversion.autocast

     Automatically detect the true Python type of a string and cast it to the correct type.
 
 Based on https://github.com/cgreer/cgAutoCast/blob/master/cgAutoCast.py
+
+Only used by Legacy configuration file parser.
 """
 
 import contextlib
diff --git a/_modules/bumpversion/bump.html b/_modules/bumpversion/bump.html
index baa90c63..11afe447 100644
--- a/_modules/bumpversion/bump.html
+++ b/_modules/bumpversion/bump.html
@@ -184,6 +184,13 @@
 
  • bumpversion.config.files_legacy
    •
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -248,7 +254,7 @@

    Source code for bumpversion.bump

     
 if TYPE_CHECKING:  # pragma: no-coverage
     from bumpversion.files import ConfiguredFile
-    from bumpversion.version_part import Version
+    from bumpversion.versioning.models import Version
 
 from bumpversion.config import Config
 from bumpversion.config.files import update_config_file
@@ -287,11 +293,11 @@ 
    Source code for bumpversion.bump
         elif version_part:
         logger.info("Attempting to increment part '%s'", version_part)
         logger.indent()
-        next_version = current_version.bump(version_part, config.version_config.order)
+        next_version = current_version.bump(version_part)
     else:
         raise ConfigurationError("Unable to get the next version.")
 
-    logger.info("Values are now: %s", key_val_string(next_version.values))
+    logger.info("Values are now: %s", key_val_string(next_version.components))
     logger.dedent()
     return next_version
    
 
@@ -364,7 +370,7 @@ 
    Source code for bumpversion.bump
         dry_run: bool = False,
 ) -> None:
     """
-    Commit and tag the changes, if a tool is configured.
+    Commit and tag the changes if a tool is configured.
 
     Args:
         config: The configuration
diff --git a/_modules/bumpversion/config.html b/_modules/bumpversion/config.html
index 32b46b9a..8a1fb9cb 100644
--- a/_modules/bumpversion/config.html
+++ b/_modules/bumpversion/config.html
@@ -184,6 +184,13 @@
 
  • bumpversion.config.files_legacy
    •
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/config/files.html b/_modules/bumpversion/config/files.html index 620eb836..968bc330 100644 --- a/_modules/bumpversion/config/files.html +++ b/_modules/bumpversion/config/files.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -253,7 +259,7 @@

    Source code for bumpversion.config.files

     
 if TYPE_CHECKING:  # pragma: no-coverage
     from bumpversion.config.models import Config
-    from bumpversion.version_part import Version
+    from bumpversion.versioning.models import Version
 
 logger = get_indented_logger(__name__)
 
diff --git a/_modules/bumpversion/config/files_legacy.html b/_modules/bumpversion/config/files_legacy.html
index ead6d80a..a711ac91 100644
--- a/_modules/bumpversion/config/files_legacy.html
+++ b/_modules/bumpversion/config/files_legacy.html
@@ -184,6 +184,13 @@
 
  • bumpversion.config.files_legacy
    •
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/config/models.html b/_modules/bumpversion/config/models.html index a31942ff..eeea751f 100644 --- a/_modules/bumpversion/config/models.html +++ b/_modules/bumpversion/config/models.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -253,27 +259,16 @@

    Source code for bumpversion.config.models

     from pydantic_settings import BaseSettings, SettingsConfigDict
 
 from bumpversion.ui import get_indented_logger
+from bumpversion.versioning.models import VersionComponentConfig  # NOQA: TCH001
 
 if TYPE_CHECKING:
     from bumpversion.scm import SCMInfo
     from bumpversion.version_part import VersionConfig
+    from bumpversion.versioning.models import VersionSpec
 
 logger = get_indented_logger(__name__)
 
 
-
    
-[docs]
-class VersionPartConfig(BaseModel):
-    """Configuration of a part of the version."""
-
-    values: Optional[list] = None  # Optional. Numeric is used if missing or no items in list
-    optional_value: Optional[str] = None  # Optional.
-    # Defaults to first value. 0 in the case of numeric. Empty string means nothing is optional.
-    first_value: Union[str, int, None] = None  # Optional. Defaults to first value in values
-    independent: bool = False
    
-
-
-
 
    
 [docs]
 class FileChange(BaseModel):
@@ -357,7 +352,7 @@ 
    Source code for bumpversion.config.models
         message: str
     commit_args: Optional[str]
     scm_info: Optional["SCMInfo"]
-    parts: Dict[str, VersionPartConfig]
+    parts: Dict[str, VersionComponentConfig]
     files: List[FileChange] = Field(default_factory=list)
     included_paths: List[str] = Field(default_factory=list)
     excluded_paths: List[str] = Field(default_factory=list)
@@ -431,7 +426,16 @@ 
    Source code for bumpversion.config.models
             """Return the version configuration."""
         from bumpversion.version_part import VersionConfig
 
-        return VersionConfig(self.parse, self.serialize, self.search, self.replace, self.parts)
    
+        return VersionConfig(self.parse, self.serialize, self.search, self.replace, self.parts)
+
+
    
+[docs]
+    def version_spec(self, version: Optional[str] = None) -> "VersionSpec":
+        """Return the version specification."""
+        from bumpversion.versioning.models import VersionSpec
+
+        return VersionSpec(self.parts)
    
+
    diff --git a/_modules/bumpversion/config/utils.html b/_modules/bumpversion/config/utils.html index ac30f65b..0ae571f4 100644 --- a/_modules/bumpversion/config/utils.html +++ b/_modules/bumpversion/config/utils.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -245,11 +251,11 @@

    Source code for bumpversion.config.utils

     from __future__ import annotations
 
 import glob
-import itertools
 from typing import Dict, List
 
-from bumpversion.config.models import FileChange, VersionPartConfig
-from bumpversion.utils import labels_for_format
+from bumpversion.config.models import FileChange
+from bumpversion.exceptions import BumpVersionError
+from bumpversion.versioning.models import VersionComponentConfig
 
 
 
    
@@ -273,15 +279,25 @@ 
    Source code for bumpversion.config.utils
     
 
    
 [docs]
-def get_all_part_configs(config_dict: dict) -> Dict[str, VersionPartConfig]:
+def get_all_part_configs(config_dict: dict) -> Dict[str, VersionComponentConfig]:
     """Make sure all version parts are included."""
-    serialize = config_dict["serialize"]
+    import re
+
+    try:
+        parsing_groups = list(re.compile(config_dict["parse"]).groupindex.keys())
+    except re.error as e:
+        raise BumpVersionError(f"Could not parse regex '{config_dict['parse']}': {e}") from e
     parts = config_dict["parts"]
-    all_labels = set(itertools.chain.from_iterable([labels_for_format(fmt) for fmt in serialize]))
-    return {
-        label: VersionPartConfig(**parts[label]) if label in parts else VersionPartConfig()  # type: ignore[call-arg]
-        for label in all_labels
-    }
    
+
+    part_configs = {}
+    for label in parsing_groups:
+        is_independent = label.startswith("$")
+        part_configs[label] = (
+            VersionComponentConfig(**parts[label])
+            if label in parts
+            else VersionComponentConfig(independent=is_independent)
+        )
+    return part_configs
    
 
 
 
diff --git a/_modules/bumpversion/exceptions.html b/_modules/bumpversion/exceptions.html
index 447b2e5e..6d4f5dee 100644
--- a/_modules/bumpversion/exceptions.html
+++ b/_modules/bumpversion/exceptions.html
@@ -184,6 +184,13 @@
 
  • bumpversion.config.files_legacy
    •
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/files.html b/_modules/bumpversion/files.html index 84a0f2be..5b0dcff2 100644 --- a/_modules/bumpversion/files.html +++ b/_modules/bumpversion/files.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -249,11 +255,12 @@

    Source code for bumpversion.files

     from pathlib import Path
 from typing import Dict, List, MutableMapping, Optional
 
-from bumpversion.config.models import FileChange, VersionPartConfig
+from bumpversion.config.models import FileChange
 from bumpversion.exceptions import VersionNotFoundError
 from bumpversion.ui import get_indented_logger
 from bumpversion.utils import get_nested_value, set_nested_value
-from bumpversion.version_part import Version, VersionConfig
+from bumpversion.version_part import VersionConfig
+from bumpversion.versioning.models import Version, VersionComponentConfig
 
 logger = get_indented_logger(__name__)
 
@@ -583,7 +590,7 @@ 
    Source code for bumpversion.files
         def __init__(
         self,
         file_change: FileChange,
-        version_part_configs: Dict[str, VersionPartConfig],
+        version_part_configs: Dict[str, VersionComponentConfig],
     ) -> None:
         self.file_change = file_change
         self.version_config = VersionConfig(
diff --git a/_modules/bumpversion/indented_logger.html b/_modules/bumpversion/indented_logger.html
index 56a5d314..886beb12 100644
--- a/_modules/bumpversion/indented_logger.html
+++ b/_modules/bumpversion/indented_logger.html
@@ -184,6 +184,13 @@
 
  • bumpversion.config.files_legacy
    •
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/scm.html b/_modules/bumpversion/scm.html index 86e691c8..1b681b10 100644 --- a/_modules/bumpversion/scm.html +++ b/_modules/bumpversion/scm.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/show.html b/_modules/bumpversion/show.html index 2651eb05..28363f6f 100644 --- a/_modules/bumpversion/show.html +++ b/_modules/bumpversion/show.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/ui.html b/_modules/bumpversion/ui.html index 90654cd8..869f1fe8 100644 --- a/_modules/bumpversion/ui.html +++ b/_modules/bumpversion/ui.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/utils.html b/_modules/bumpversion/utils.html index 10b0642f..4550c205 100644 --- a/_modules/bumpversion/utils.html +++ b/_modules/bumpversion/utils.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -251,7 +257,7 @@

    Source code for bumpversion.utils

     if TYPE_CHECKING:  # pragma: no-coverage
     from bumpversion.config import Config
     from bumpversion.scm import SCMInfo
-    from bumpversion.version_part import Version
+    from bumpversion.versioning.models import Version
 
 
 
    
diff --git a/_modules/bumpversion/version_part.html b/_modules/bumpversion/version_part.html
index cefc6f66..7dc736ce 100644
--- a/_modules/bumpversion/version_part.html
+++ b/_modules/bumpversion/version_part.html
@@ -184,6 +184,13 @@
 
  • bumpversion.config.files_legacy
    •
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -243,174 +249,18 @@

    Source code for bumpversion.version_part

     """Module for managing Versions and their internal parts."""
 import re
-import string
-from copy import copy
-from typing import Any, Dict, List, MutableMapping, Optional, Tuple, Union
+from typing import Any, Dict, List, MutableMapping, Optional, Tuple
 
 from click import UsageError
 
-from bumpversion.config.models import VersionPartConfig
-from bumpversion.exceptions import FormattingError, InvalidVersionPartError, MissingValueError
-from bumpversion.functions import NumericFunction, PartFunction, ValuesFunction
 from bumpversion.ui import get_indented_logger
-from bumpversion.utils import key_val_string, labels_for_format
+from bumpversion.utils import labels_for_format
+from bumpversion.versioning.models import Version, VersionComponentConfig, VersionSpec
+from bumpversion.versioning.serialization import parse_version, serialize
 
 logger = get_indented_logger(__name__)
 
 
-
    
-[docs]
-class VersionPart:
-    """
-    Represent part of a version number.
-
-    Determines the PartFunction that rules how the part behaves when increased or reset
-    based on the configuration given.
-    """
-
-    def __init__(self, config: VersionPartConfig, value: Union[str, int, None] = None):
-        self._value = str(value) if value is not None else None
-        self.config = config
-        self.func: Optional[PartFunction] = None
-        if config.values:
-            str_values = [str(v) for v in config.values]
-            str_optional_value = str(config.optional_value) if config.optional_value is not None else None
-            str_first_value = str(config.first_value) if config.first_value is not None else None
-            self.func = ValuesFunction(str_values, str_optional_value, str_first_value)
-        else:
-            self.func = NumericFunction(config.optional_value, config.first_value or "0")
-
-    @property
-    def value(self) -> str:
-        """Return the value of the part."""
-        return self._value or self.func.optional_value
-
-
    
-[docs]
-    def copy(self) -> "VersionPart":
-        """Return a copy of the part."""
-        return VersionPart(self.config, self._value)
    
-
-
-
    
-[docs]
-    def bump(self) -> "VersionPart":
-        """Return a part with bumped value."""
-        return VersionPart(self.config, self.func.bump(self.value))
    
-
-
-
    
-[docs]
-    def null(self) -> "VersionPart":
-        """Return a part with first value."""
-        return VersionPart(self.config, self.func.first_value)
    
-
-
-    @property
-    def is_optional(self) -> bool:
-        """Is the part optional?"""
-        return self.value == self.func.optional_value
-
-    @property
-    def is_independent(self) -> bool:
-        """Is the part independent of the other parts?"""
-        return self.config.independent
-
-
    
-[docs]
-    def __format__(self, format_spec: str) -> str:
-        try:
-            val = int(self.value)
-        except ValueError:
-            return self.value
-        else:
-            return int.__format__(val, format_spec)
    
-
-
-
    
-[docs]
-    def __repr__(self) -> str:
-        return f"<bumpversion.VersionPart:{self.func.__class__.__name__}:{self.value}>"
    
-
-
-
    
-[docs]
-    def __eq__(self, other: Any) -> bool:
-        return self.value == other.value if isinstance(other, VersionPart) else False
    
-
    
-
-
-
-
    
-[docs]
-class Version:
-    """The specification of a version and its parts."""
-
-    def __init__(self, values: Dict[str, VersionPart], original: Optional[str] = None):
-        self.values = values
-        self.original = original
-
-
    
-[docs]
-    def __getitem__(self, key: str) -> VersionPart:
-        return self.values[key]
    
-
-
-
    
-[docs]
-    def __len__(self) -> int:
-        return len(self.values)
    
-
-
-
    
-[docs]
-    def __iter__(self):
-        return iter(self.values)
    
-
-
-
    
-[docs]
-    def __repr__(self):
-        return f"<bumpversion.Version:{key_val_string(self.values)}>"
    
-
-
-
    
-[docs]
-    def __eq__(self, other: Any) -> bool:
-        return (
-            all(value == other.values[key] for key, value in self.values.items())
-            if isinstance(other, Version)
-            else False
-        )
    
-
-
-
    
-[docs]
-    def bump(self, part_name: str, order: List[str]) -> "Version":
-        """Increase the value of the given part."""
-        bumped = False
-
-        new_values = {}
-
-        for label in order:
-            if label not in self.values:
-                continue
-            if label == part_name:
-                new_values[label] = self.values[label].bump()
-                bumped = True
-            elif bumped and not self.values[label].is_independent:
-                new_values[label] = self.values[label].null()
-            else:
-                new_values[label] = self.values[label].copy()
-
-        if not bumped:
-            raise InvalidVersionPartError(f"No part named {part_name!r}")
-
-        return Version(new_values)
    
-
    
-
-
-
 
    
 [docs]
 class VersionConfig:
@@ -424,7 +274,7 @@ 
    Source code for bumpversion.version_part
             serialize: Tuple[str],
         search: str,
         replace: str,
-        part_configs: Optional[Dict[str, VersionPartConfig]] = None,
+        part_configs: Optional[Dict[str, VersionComponentConfig]] = None,
     ):
         try:
             self.parse_regex = re.compile(parse, re.VERBOSE)
@@ -433,6 +283,7 @@ 
    Source code for bumpversion.version_part
     
         self.serialize_formats = serialize
         self.part_configs = part_configs or {}
+        self.version_spec = VersionSpec(self.part_configs)
         # TODO: I think these two should be removed from the config object
         self.search = search
         self.replace = replace
@@ -480,136 +331,14 @@ 
    Source code for bumpversion.version_part
             Returns:
             A Version object representing the string.
         """
-        if not version_string:
-            return None
-
-        regexp_one_line = "".join([line.split("#")[0].strip() for line in self.parse_regex.pattern.splitlines()])
-
-        logger.info(
-            "Parsing version '%s' using regexp '%s'",
-            version_string,
-            regexp_one_line,
-        )
-        logger.indent()
+        parsed = parse_version(version_string, self.parse_regex.pattern)
 
-        match = self.parse_regex.search(version_string)
-
-        if not match:
-            logger.warning(
-                "Evaluating 'parse' option: '%s' does not parse current version '%s'",
-                self.parse_regex.pattern,
-                version_string,
-            )
+        if not parsed:
             return None
 
-        _parsed = {
-            key: VersionPart(self.part_configs[key], value)
-            for key, value in match.groupdict().items()
-            if key in self.part_configs
-        }
-        v = Version(_parsed, version_string)
-
-        logger.info("Parsed the following values: %s", key_val_string(v.values))
-        logger.dedent()
-
-        return v
    
-
-
-
    
-[docs]
-    def _serialize(
-        self, version: Version, serialize_format: str, context: MutableMapping, raise_if_incomplete: bool = False
-    ) -> str:
-        """
-        Attempts to serialize a version with the given serialization format.
-
-        Args:
-            version: The version to serialize
-            serialize_format: The serialization format to use, using Python's format string syntax
-            context: The context to use when serializing the version
-            raise_if_incomplete: Whether to raise an error if the version is incomplete
-
-        Raises:
-            FormattingError: if not serializable
-            MissingValueError: if not all parts required in the format have values
-
-        Returns:
-            The serialized version as a string
-        """
-        values = copy(context)
-        for k in version:
-            values[k] = version[k]
-
-        # TODO dump complete context on debug level
-
-        try:
-            # test whether all parts required in the format have values
-            serialized = serialize_format.format(**values)
-
-        except KeyError as e:
-            missing_key = getattr(e, "message", e.args[0])
-            raise MissingValueError(
-                f"Did not find key {missing_key!r} in {version!r} when serializing version number"
-            ) from e
-
-        keys_needing_representation = set()
-
-        keys = list(self.order)
-        for i, k in enumerate(keys):
-            v = values[k]
-
-            if not isinstance(v, VersionPart):
-                # values coming from environment variables don't need
-                # representation
-                continue
-
-            if not v.is_optional:
-                keys_needing_representation = set(keys[: i + 1])
-
-        required_by_format = set(labels_for_format(serialize_format))
-
-        # try whether all parsed keys are represented
-        if raise_if_incomplete and not keys_needing_representation <= required_by_format:
-            missing_keys = keys_needing_representation ^ required_by_format
-            raise FormattingError(
-                f"""Could not represent '{"', '".join(missing_keys)}' in format '{serialize_format}'"""
-            )
-
-        return serialized
    
-
-
-
    
-[docs]
-    def _choose_serialize_format(self, version: Version, context: MutableMapping) -> str:
-        chosen = None
-
-        logger.debug("Evaluating serialization formats")
-        logger.indent()
-        for serialize_format in self.serialize_formats:
-            try:
-                self._serialize(version, serialize_format, context, raise_if_incomplete=True)
-                # Prefer shorter or first search expression.
-                chosen_part_count = len(list(string.Formatter().parse(chosen))) if chosen else None
-                serialize_part_count = len(list(string.Formatter().parse(serialize_format)))
-                if not chosen or chosen_part_count > serialize_part_count:
-                    chosen = serialize_format
-                    logger.debug("Found '%s' to be a usable serialization format", chosen)
-                else:
-                    logger.debug("Found '%s' usable serialization format, but it's longer", serialize_format)
-            except FormattingError:
-                # If chosen, prefer shorter
-                if not chosen:
-                    chosen = serialize_format
-            except MissingValueError as e:
-                logger.info(e.message)
-                raise e
-
-        if not chosen:
-            raise KeyError("Did not find suitable serialization format")
-        logger.dedent()
-        logger.debug("Selected serialization format '%s'", chosen)
-
-        return chosen
    
+        version = self.version_spec.create_version(parsed)
+        version.original = version_string
+        return version
    
 
 
 
    
@@ -625,12 +354,7 @@ 
    Source code for bumpversion.version_part
             Returns:
             The serialized version as a string
         """
-        logger.debug("Serializing version '%s'", version)
-        logger.indent()
-        serialized = self._serialize(version, self._choose_serialize_format(version, context), context)
-        logger.debug("Serialized to '%s'", serialized)
-        logger.dedent()
-        return serialized
    
+        return serialize(version, list(self.serialize_formats), context)
    diff --git a/_modules/bumpversion/versioning/conventions.html b/_modules/bumpversion/versioning/conventions.html new file mode 100644 index 00000000..7d4b3bef --- /dev/null +++ b/_modules/bumpversion/versioning/conventions.html @@ -0,0 +1,411 @@ + + + + + + + + bumpversion.versioning.conventions - Bump My Version 0.17.1 + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bump My Version 0.17.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    +
    + +
    + +
    +
    +

    Source code for bumpversion.versioning.conventions

    +"""Standard version conventions."""
+from bumpversion.versioning.models import VersionComponentConfig, VersionSpec
+
+# Adapted from https://packaging.python.org/en/latest/specifications/version-specifiers/
+PEP440_PATTERN = r"""
+    v?
+    (?:
+        (?P<major>0|[1-9]\d*)\.
+        (?P<minor>0|[1-9]\d*)\.
+        (?P<patch>0|[1-9]\d*)
+        (?:                                          # pre-release
+            [-_\.]?
+            (?P<pre>
+                (?P<pre_l>a|b|c|rc|alpha|beta|pre|preview)
+                [-_\.]?
+                (?P<pre_n>[0-9]+)?
+            )
+        )?
+        (?:                                          # post release
+            [-_\.]?
+            (?P<post>
+                post
+                [-_\.]?
+                [0-9]+
+            )
+        )?
+        (?:                                          # dev release
+            [-_\.]?
+            (?P<dev>
+                dev
+                [-_\.]?
+                [0-9]+
+            )
+        )?
+    )
+    (?:\+(?P<local>[a-z0-9]+(?:[-_\.][a-z0-9]+)*))?   # local version
+"""
+PEP440_SERIALIZE_PATTERNS = [
+    "{major}.{minor}.{patch}{pre_l}{pre_n}.{post}.{dev}+{local}",
+    "{major}.{minor}.{patch}{pre_l}{pre_n}.{post}.{dev}",
+    "{major}.{minor}.{patch}{pre_l}{pre_n}.{post}+{local}",
+    "{major}.{minor}.{patch}{pre_l}{pre_n}.{dev}+{local}",
+    "{major}.{minor}.{patch}.{post}.{dev}+{local}",
+    "{major}.{minor}.{patch}{pre_l}{pre_n}.{post}",
+    "{major}.{minor}.{patch}{pre_l}{pre_n}.{dev}",
+    "{major}.{minor}.{patch}{pre_l}{pre_n}+{local}",
+    "{major}.{minor}.{patch}.{post}.{dev}",
+    "{major}.{minor}.{patch}.{post}+{local}",
+    "{major}.{minor}.{patch}.{dev}+{local}",
+    "{major}.{minor}.{patch}.{pre_l}{pre_n}",
+    "{major}.{minor}.{patch}.{post}",
+    "{major}.{minor}.{patch}.{dev}",
+    "{major}.{minor}.{patch}+{local}",
+    "{major}.{minor}.{patch}",
+]
+PEP440_COMPONENT_CONFIGS = {
+    "major": VersionComponentConfig(),
+    "minor": VersionComponentConfig(),
+    "patch": VersionComponentConfig(),
+    "pre_l": VersionComponentConfig(values=["", "a", "b", "rc"]),
+    "pre_n": VersionComponentConfig(),
+    "post": VersionComponentConfig(depends_on="patch"),
+    "dev": VersionComponentConfig(depends_on="patch"),
+    "local": VersionComponentConfig(depends_on="patch", optional_value=""),
+}
+
+
+
    
+[docs]
+def pep440_version_spec() -> VersionSpec:
+    """Return a VersionSpec for PEP 440."""
+    return VersionSpec(components=PEP440_COMPONENT_CONFIGS)
    
+
+
+
+# Adapted from https://regex101.com/r/Ly7O1x/3/
+SEMVER_PATTERN = r"""
+    (?P<major>0|[1-9]\d*)\.
+    (?P<minor>0|[1-9]\d*)\.
+    (?P<patch>0|[1-9]\d*)
+    (?:
+        -                             # dash seperator for pre-release section
+        (?P<pre_l>[a-zA-Z-]+)         # pre-release label
+        (?P<pre_n>0|[1-9]\d*)         # pre-release version number
+    )?                                # pre-release section is optional
+    (?:
+        \+                            # plus seperator for build metadata section
+        (?P<buildmetadata>
+            [0-9a-zA-Z-]+
+            (?:\.[0-9a-zA-Z-]+)*
+        )
+    )?                                # build metadata section is optional
+"""
+SEMVER_SERIALIZE_PATTERNS = [
+    "{major}.{minor}.{patch}-{pre_l}{pre_n}+{buildmetadata}",
+    "{major}.{minor}.{patch}-{pre_l}{pre_n}",
+    "{major}.{minor}.{patch}+{buildmetadata}",
+    "{major}.{minor}.{patch}",
+]
+SEMVER_COMPONENT_CONFIGS = {
+    "major": VersionComponentConfig(),
+    "minor": VersionComponentConfig(),
+    "patch": VersionComponentConfig(),
+    "pre_l": VersionComponentConfig(values=["", "a", "b", "rc"]),
+    "pre_n": VersionComponentConfig(),
+    "buildmetadata": VersionComponentConfig(independent=True),
+}
+
+
+
    
+[docs]
+def semver_spec() -> VersionSpec:
+    """Return a VersionSpec for SEMVER."""
+    return VersionSpec(components=SEMVER_COMPONENT_CONFIGS)
    
+
+
    +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/_modules/bumpversion/functions.html b/_modules/bumpversion/versioning/functions.html similarity index 64% rename from _modules/bumpversion/functions.html rename to _modules/bumpversion/versioning/functions.html index de827612..72d9ea78 100644 --- a/_modules/bumpversion/functions.html +++ b/_modules/bumpversion/versioning/functions.html @@ -1,16 +1,16 @@ - + - + - bumpversion.functions - Bump My Version 0.17.1 - - - - - + bumpversion.versioning.functions - Bump My Version 0.17.1 + + + + + @@ -124,7 +124,7 @@
    -
    Bump My Version 0.17.1
     +
    Bump My Version 0.17.1
    @@ -144,12 +144,12 @@
    -
    - - - - - + + + + + + \ No newline at end of file diff --git a/_modules/bumpversion/versioning/models.html b/_modules/bumpversion/versioning/models.html new file mode 100644 index 00000000..6c858ab3 --- /dev/null +++ b/_modules/bumpversion/versioning/models.html @@ -0,0 +1,578 @@ + + + + + + + + bumpversion.versioning.models - Bump My Version 0.17.1 + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bump My Version 0.17.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    +
    + +
    + +
    +
    +

    Source code for bumpversion.versioning.models

    +"""Models for managing versioning of software projects."""
+from __future__ import annotations
+
+from collections import defaultdict, deque
+from typing import Any, Dict, List, Optional, Union
+
+from pydantic import BaseModel
+
+from bumpversion.exceptions import InvalidVersionPartError
+from bumpversion.utils import key_val_string
+from bumpversion.versioning.functions import NumericFunction, PartFunction, ValuesFunction
+
+
+
    
+[docs]
+class VersionComponent:
+    """
+    Represent part of a version number.
+
+    Determines the PartFunction that rules how the part behaves when increased or reset
+    based on the configuration given.
+    """
+
+    def __init__(
+        self,
+        values: Optional[list] = None,
+        optional_value: Optional[str] = None,
+        first_value: Union[str, int, None] = None,
+        independent: bool = False,
+        source: Optional[str] = None,
+        value: Union[str, int, None] = None,
+    ):
+        self._value = str(value) if value is not None else None
+        self.func: Optional[PartFunction] = None
+        self.independent = independent
+        self.source = source
+        if values:
+            str_values = [str(v) for v in values]
+            str_optional_value = str(optional_value) if optional_value is not None else None
+            str_first_value = str(first_value) if first_value is not None else None
+            self.func = ValuesFunction(str_values, str_optional_value, str_first_value)
+        else:
+            self.func = NumericFunction(optional_value, first_value or "0")
+
+    @property
+    def value(self) -> str:
+        """Return the value of the part."""
+        return self._value or self.func.optional_value
+
+
    
+[docs]
+    def copy(self) -> "VersionComponent":
+        """Return a copy of the part."""
+        return VersionComponent(
+            values=getattr(self.func, "_values", None),
+            optional_value=self.func.optional_value,
+            first_value=self.func.first_value,
+            independent=self.independent,
+            source=self.source,
+            value=self._value,
+        )
    
+
+
+
    
+[docs]
+    def bump(self) -> "VersionComponent":
+        """Return a part with bumped value."""
+        new_component = self.copy()
+        new_component._value = self.func.bump(self.value)
+        return new_component
    
+
+
+
    
+[docs]
+    def null(self) -> "VersionComponent":
+        """Return a part with first value."""
+        new_component = self.copy()
+        new_component._value = self.func.first_value
+        return new_component
    
+
+
+    @property
+    def is_optional(self) -> bool:
+        """Is the part optional?"""
+        return self.value == self.func.optional_value
+
+    @property
+    def is_independent(self) -> bool:
+        """Is the part independent of the other parts?"""
+        return self.independent
+
+
    
+[docs]
+    def __format__(self, format_spec: str) -> str:
+        try:
+            val = int(self.value)
+        except ValueError:
+            return self.value
+        else:
+            return int.__format__(val, format_spec)
    
+
+
+
    
+[docs]
+    def __repr__(self) -> str:
+        return f"<bumpversion.VersionPart:{self.func.__class__.__name__}:{self.value}>"
    
+
+
+
    
+[docs]
+    def __eq__(self, other: Any) -> bool:
+        return self.value == other.value if isinstance(other, VersionComponent) else False
    
+
    
+
+
+
+
    
+[docs]
+class VersionComponentConfig(BaseModel):
+    """
+    Configuration of a version component.
+
+    This is used to read in the configuration from the bumpversion config file.
+    """
+
+    values: Optional[list] = None  # Optional. Numeric is used if missing or no items in list
+    optional_value: Optional[str] = None  # Optional.
+    # Defaults to first value. 0 in the case of numeric. Empty string means nothing is optional.
+    first_value: Union[str, int, None] = None  # Optional. Defaults to first value in values
+    independent: bool = False
+    # source: Optional[str] = None  # Name of environment variable or context variable to use as the source for value
+    depends_on: Optional[str] = None  # The name of the component this component depends on
+
+
    
+[docs]
+    def create_component(self, value: Union[str, int, None] = None) -> VersionComponent:
+        """Generate a version component from the configuration."""
+        return VersionComponent(
+            values=self.values,
+            optional_value=self.optional_value,
+            first_value=self.first_value,
+            independent=self.independent,
+            # source=self.source,
+            value=value,
+        )
    
+
    
+
+
+
+
    
+[docs]
+class VersionSpec:
+    """The specification of a version's components and their relationships."""
+
+    def __init__(self, components: Dict[str, VersionComponentConfig], order: Optional[List[str]] = None):
+        if not components:
+            raise ValueError("A VersionSpec must have at least one component.")
+        if not order:
+            order = list(components.keys())
+        if len(set(order) - set(components.keys())) > 0:
+            raise ValueError("The order of components refers to items that are not in your components.")
+
+        self.component_configs = components
+        self.order = order
+        self.dependency_map = defaultdict(list)
+        previous_component = self.order[0]
+        for component in self.order[1:]:
+            if self.component_configs[component].independent:
+                continue
+            elif self.component_configs[component].depends_on:
+                self.dependency_map[self.component_configs[component].depends_on].append(component)
+            else:
+                self.dependency_map[previous_component].append(component)
+            previous_component = component
+
+
    
+[docs]
+    def create_version(self, values: Dict[str, str]) -> "Version":
+        """Generate a version from the given values."""
+        components = {
+            key: comp_config.create_component(value=values.get(key))
+            for key, comp_config in self.component_configs.items()
+        }
+        return Version(version_spec=self, components=components)
    
+
+
+
    
+[docs]
+    def get_dependents(self, component_name: str) -> List[str]:
+        """Return the parts that depend on the given part."""
+        stack = deque(self.dependency_map.get(component_name, []), maxlen=len(self.order))
+        visited = []
+
+        while stack:
+            e = stack.pop()
+            if e not in visited:
+                visited.append(e)
+                stack.extendleft(self.dependency_map[e])
+
+        return visited
    
+
    
+
+
+
+
    
+[docs]
+class Version:
+    """The specification of a version and its parts."""
+
+    def __init__(
+        self, version_spec: VersionSpec, components: Dict[str, VersionComponent], original: Optional[str] = None
+    ):
+        self.version_spec = version_spec
+        self.components = components
+        self.original = original
+
+
    
+[docs]
+    def values(self) -> Dict[str, str]:
+        """Return the values of the parts."""
+        return {key: value.value for key, value in self.components.items()}
    
+
+
+
    
+[docs]
+    def __getitem__(self, key: str) -> VersionComponent:
+        return self.components[key]
    
+
+
+
    
+[docs]
+    def __len__(self) -> int:
+        return len(self.components)
    
+
+
+
    
+[docs]
+    def __iter__(self):
+        return iter(self.components)
    
+
+
+
    
+[docs]
+    def __repr__(self):
+        return f"<bumpversion.Version:{key_val_string(self.components)}>"
    
+
+
+
    
+[docs]
+    def __eq__(self, other: Any) -> bool:
+        return (
+            all(value == other.components[key] for key, value in self.components.items())
+            if isinstance(other, Version)
+            else False
+        )
    
+
+
+
    
+[docs]
+    def required_components(self) -> List[str]:
+        """Return the names of the parts that are required."""
+        return [key for key, value in self.components.items() if value.value != value.func.optional_value]
    
+
+
+
    
+[docs]
+    def bump(self, component_name: str) -> "Version":
+        """Increase the value of the specified component, reset its dependents, and return a new Version."""
+        if component_name not in self.components:
+            raise InvalidVersionPartError(f"No part named {component_name!r}")
+
+        components_to_reset = self.version_spec.get_dependents(component_name)
+
+        new_values = dict(self.components.items())
+        new_values[component_name] = self.components[component_name].bump()
+        for component in components_to_reset:
+            if not self.components[component].is_independent:
+                new_values[component] = self.components[component].null()
+
+        return Version(self.version_spec, new_values, self.original)
    
+
    
+
+
    +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/_modules/bumpversion/versioning/serialization.html b/_modules/bumpversion/versioning/serialization.html new file mode 100644 index 00000000..1ac3c5b8 --- /dev/null +++ b/_modules/bumpversion/versioning/serialization.html @@ -0,0 +1,442 @@ + + + + + + + + bumpversion.versioning.serialization - Bump My Version 0.17.1 + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bump My Version 0.17.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    +
    + +
    + +
    +
    +

    Source code for bumpversion.versioning.serialization

    +"""Functions for serializing and deserializing version objects."""
+import re
+from copy import copy
+from operator import itemgetter
+from typing import Dict, List, MutableMapping
+
+from bumpversion.exceptions import BumpVersionError, FormattingError
+from bumpversion.ui import get_indented_logger
+from bumpversion.utils import key_val_string, labels_for_format
+from bumpversion.versioning.models import Version
+
+logger = get_indented_logger(__name__)
+
+
+
    
+[docs]
+def parse_version(version_string: str, parse_pattern: str) -> Dict[str, str]:
+    """
+    Parse a version string into a dictionary of the parts and values using a regular expression.
+
+    Args:
+        version_string: Version string to parse
+        parse_pattern: The regular expression pattern to use for parsing
+
+    Returns:
+        A dictionary of version part labels and their values, or an empty dictionary
+        if the version string doesn't match.
+
+    Raises:
+        BumpVersionError: If the parse_pattern is not a valid regular expression
+    """
+    if not version_string:
+        logger.debug("Version string is empty, returning empty dict")
+        return {}
+    elif not parse_pattern:
+        logger.debug("Parse pattern is empty, returning empty dict")
+        return {}
+
+    logger.debug("Parsing version '%s' using regexp '%s'", version_string, parse_pattern)
+    logger.indent()
+
+    try:
+        pattern = re.compile(parse_pattern, re.VERBOSE)
+    except re.error as e:
+        raise BumpVersionError(f"'{parse_pattern}' is not a valid regular expression.") from e
+
+    match = re.search(pattern, version_string)
+
+    if not match:
+        logger.debug(
+            "'%s' does not parse current version '%s'",
+            parse_pattern,
+            version_string,
+        )
+        return {}
+
+    parsed = match.groupdict(default="")
+    logger.debug("Parsed the following values: %s", key_val_string(parsed))
+    logger.dedent()
+
+    return parsed
    
+
+
+
+
    
+[docs]
+def multisort(xs: list, specs: tuple) -> list:
+    """
+    Sort a list of dictionaries by multiple keys.
+
+    From https://docs.python.org/3/howto/sorting.html#sort-stability-and-complex-sorts
+
+    Args:
+        xs: The list of dictionaries to sort
+        specs: A tuple of (key, reverse) pairs
+
+    Returns:
+        The sorted list
+    """
+    for key, reverse in reversed(specs):
+        xs.sort(key=itemgetter(key), reverse=reverse)
+    return xs
    
+
+
+
+
    
+[docs]
+def serialize(version: Version, serialize_patterns: List[str], context: MutableMapping) -> str:
+    """
+    Attempts to serialize a version with the given serialization format.
+
+    - valid serialization patterns are those that are renderable with the given context
+    - formats that contain all required components are preferred
+    - the shortest valid serialization pattern is used
+    - if two patterns are equally short, the first one is used
+    - if no valid serialization pattern is found, an error is raised
+
+    Args:
+        version: The version to serialize
+        serialize_patterns: The serialization format to use, using Python's format string syntax
+        context: The context to use when serializing the version
+
+    Raises:
+        FormattingError: if a serialization pattern
+
+    Returns:
+        The serialized version as a string
+    """
+    logger.debug("Serializing version '%s'", version)
+    logger.indent()
+
+    local_context = copy(context)
+    local_context.update(version.values())
+    local_context_keys = set(local_context.keys())
+    required_component_labels = set(version.required_components())
+
+    patterns = []
+    for index, pattern in enumerate(serialize_patterns):
+        labels = set(labels_for_format(pattern))
+        patterns.append(
+            {
+                "pattern": pattern,
+                "labels": labels,
+                "order": index,
+                "num_labels": len(labels),
+                "renderable": local_context_keys >= labels,
+                "has_required_components": required_component_labels <= labels,
+            }
+        )
+
+    valid_patterns = filter(itemgetter("renderable"), patterns)
+    sorted_patterns = multisort(
+        list(valid_patterns), (("has_required_components", True), ("num_labels", False), ("order", False))
+    )
+
+    if not sorted_patterns:
+        raise FormattingError(f"Could not find a valid serialization format in {serialize_patterns!r} for {version!r}")
+
+    chosen_pattern = sorted_patterns[0]["pattern"]
+    logger.debug("Using serialization format '%s'", chosen_pattern)
+    serialized = chosen_pattern.format(**local_context)
+    logger.debug("Serialized to '%s'", serialized)
+    logger.dedent()
+
+    return serialized
    
+
+
    +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/_modules/bumpversion/visualize.html b/_modules/bumpversion/visualize.html index 14bfb0a7..7dbb55d7 100644 --- a/_modules/bumpversion/visualize.html +++ b/_modules/bumpversion/visualize.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/bumpversion/yaml_dump.html b/_modules/bumpversion/yaml_dump.html index 26296d5e..7f0ec22d 100644 --- a/_modules/bumpversion/yaml_dump.html +++ b/_modules/bumpversion/yaml_dump.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation diff --git a/_modules/index.html b/_modules/index.html index 95555b6d..c4afb4bf 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -184,6 +184,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -194,7 +201,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -204,7 +210,7 @@ -
  • Explanation @@ -251,13 +257,16 @@

    All modules for which code is available

  • bumpversion.config.utils
  • bumpversion.exceptions
  • bumpversion.files
    • -
  • bumpversion.functions
  • bumpversion.indented_logger
  • bumpversion.scm
  • bumpversion.show
  • bumpversion.ui
  • bumpversion.utils
  • bumpversion.version_part
    • +
  • bumpversion.versioning.conventions
    • +
  • bumpversion.versioning.functions
    • +
  • bumpversion.versioning.models
    • +
  • bumpversion.versioning.serialization
  • bumpversion.visualize
  • bumpversion.yaml_dump
    • diff --git a/_sources/reference/bumpversion/bumpversion.bump.md.txt b/_sources/reference/bumpversion/bumpversion.bump.md.txt index 8e765bb1..0791e9d6 100644 --- a/_sources/reference/bumpversion/bumpversion.bump.md.txt +++ b/_sources/reference/bumpversion/bumpversion.bump.md.txt @@ -53,7 +53,7 @@ ```` -````{py:function} get_next_version(current_version: bumpversion.version_part.Version, config: bumpversion.config.Config, version_part: typing.Optional[str], new_version: typing.Optional[str]) -> bumpversion.version_part.Version +````{py:function} get_next_version(current_version: bumpversion.versioning.models.Version, config: bumpversion.config.Config, version_part: typing.Optional[str], new_version: typing.Optional[str]) -> bumpversion.versioning.models.Version :canonical: bumpversion.bump.get_next_version ```{autodoc2-docstring} bumpversion.bump.get_next_version diff --git a/_sources/reference/bumpversion/bumpversion.config.files.md.txt b/_sources/reference/bumpversion/bumpversion.config.files.md.txt index 9beb1c4e..5adb6d16 100644 --- a/_sources/reference/bumpversion/bumpversion.config.files.md.txt +++ b/_sources/reference/bumpversion/bumpversion.config.files.md.txt @@ -92,7 +92,7 @@ ``` ```` -````{py:function} update_config_file(config_file: typing.Union[str, pathlib.Path], config: bumpversion.config.models.Config, current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:function} update_config_file(config_file: typing.Union[str, pathlib.Path], config: bumpversion.config.models.Config, current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.config.files.update_config_file ```{autodoc2-docstring} bumpversion.config.files.update_config_file diff --git a/_sources/reference/bumpversion/bumpversion.config.models.md.txt b/_sources/reference/bumpversion/bumpversion.config.models.md.txt index b670f76f..00049ebd 100644 --- a/_sources/reference/bumpversion/bumpversion.config.models.md.txt +++ b/_sources/reference/bumpversion/bumpversion.config.models.md.txt @@ -15,10 +15,6 @@ :class: autosummary longtable :align: left -* - {py:obj}`VersionPartConfig ` - - ```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig - :summary: - ``` * - {py:obj}`FileChange ` - ```{autodoc2-docstring} bumpversion.config.models.FileChange :summary: @@ -53,66 +49,6 @@ ```` -`````{py:class} VersionPartConfig(**data: typing.Any) -:canonical: bumpversion.config.models.VersionPartConfig - -Bases: {py:obj}`pydantic.BaseModel` - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.__init__ -``` - -````{py:attribute} values -:canonical: bumpversion.config.models.VersionPartConfig.values -:type: typing.Optional[list] -:value: > - None - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.values -``` - -```` - -````{py:attribute} optional_value -:canonical: bumpversion.config.models.VersionPartConfig.optional_value -:type: typing.Optional[str] -:value: > - None - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.optional_value -``` - -```` - -````{py:attribute} first_value -:canonical: bumpversion.config.models.VersionPartConfig.first_value -:type: typing.Union[str, int, None] -:value: > - None - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.first_value -``` - -```` - -````{py:attribute} independent -:canonical: bumpversion.config.models.VersionPartConfig.independent -:type: bool -:value: > - False - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.independent -``` - -```` - -````` - `````{py:class} FileChange(**data: typing.Any) :canonical: bumpversion.config.models.FileChange @@ -436,7 +372,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` ````{py:attribute} parts :canonical: bumpversion.config.models.Config.parts -:type: typing.Dict[str, bumpversion.config.models.VersionPartConfig] +:type: typing.Dict[str, bumpversion.versioning.models.VersionComponentConfig] :value: > None @@ -542,4 +478,12 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` ```` +````{py:method} version_spec(version: typing.Optional[str] = None) -> bumpversion.versioning.models.VersionSpec +:canonical: bumpversion.config.models.Config.version_spec + +```{autodoc2-docstring} bumpversion.config.models.Config.version_spec +``` + +```` + ````` diff --git a/_sources/reference/bumpversion/bumpversion.config.utils.md.txt b/_sources/reference/bumpversion/bumpversion.config.utils.md.txt index 9d7e45e9..36d88667 100644 --- a/_sources/reference/bumpversion/bumpversion.config.utils.md.txt +++ b/_sources/reference/bumpversion/bumpversion.config.utils.md.txt @@ -38,7 +38,7 @@ ``` ```` -````{py:function} get_all_part_configs(config_dict: dict) -> typing.Dict[str, bumpversion.config.models.VersionPartConfig] +````{py:function} get_all_part_configs(config_dict: dict) -> typing.Dict[str, bumpversion.versioning.models.VersionComponentConfig] :canonical: bumpversion.config.utils.get_all_part_configs ```{autodoc2-docstring} bumpversion.config.utils.get_all_part_configs diff --git a/_sources/reference/bumpversion/bumpversion.files.md.txt b/_sources/reference/bumpversion/bumpversion.files.md.txt index 2257aeeb..a40b56f3 100644 --- a/_sources/reference/bumpversion/bumpversion.files.md.txt +++ b/_sources/reference/bumpversion/bumpversion.files.md.txt @@ -119,7 +119,7 @@ ```` -````{py:method} _contains_change_pattern(search_expression: re.Pattern, raw_search_expression: str, version: bumpversion.version_part.Version, context: typing.MutableMapping) -> bool +````{py:method} _contains_change_pattern(search_expression: re.Pattern, raw_search_expression: str, version: bumpversion.versioning.models.Version, context: typing.MutableMapping) -> bool :canonical: bumpversion.files.ConfiguredFile._contains_change_pattern ```{autodoc2-docstring} bumpversion.files.ConfiguredFile._contains_change_pattern @@ -127,7 +127,7 @@ ```` -````{py:method} make_file_change(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:method} make_file_change(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.files.ConfiguredFile.make_file_change ```{autodoc2-docstring} bumpversion.files.ConfiguredFile.make_file_change @@ -154,7 +154,7 @@ ``` ```` -````{py:function} modify_files(files: typing.List[bumpversion.files.ConfiguredFile], current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:function} modify_files(files: typing.List[bumpversion.files.ConfiguredFile], current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.files.modify_files ```{autodoc2-docstring} bumpversion.files.modify_files @@ -173,7 +173,7 @@ ```{autodoc2-docstring} bumpversion.files.FileUpdater.__init__ ``` -````{py:method} update_file(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:method} update_file(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.files.FileUpdater.update_file ```{autodoc2-docstring} bumpversion.files.FileUpdater.update_file @@ -183,7 +183,7 @@ ````` -`````{py:class} DataFileUpdater(file_change: bumpversion.config.models.FileChange, version_part_configs: typing.Dict[str, bumpversion.config.models.VersionPartConfig]) +`````{py:class} DataFileUpdater(file_change: bumpversion.config.models.FileChange, version_part_configs: typing.Dict[str, bumpversion.versioning.models.VersionComponentConfig]) :canonical: bumpversion.files.DataFileUpdater ```{autodoc2-docstring} bumpversion.files.DataFileUpdater @@ -195,7 +195,7 @@ ```{autodoc2-docstring} bumpversion.files.DataFileUpdater.__init__ ``` -````{py:method} update_file(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:method} update_file(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.files.DataFileUpdater.update_file ```{autodoc2-docstring} bumpversion.files.DataFileUpdater.update_file diff --git a/_sources/reference/bumpversion/bumpversion.functions.md.txt b/_sources/reference/bumpversion/bumpversion.functions.md.txt deleted file mode 100644 index 04e75998..00000000 --- a/_sources/reference/bumpversion/bumpversion.functions.md.txt +++ /dev/null @@ -1,140 +0,0 @@ -# {py:mod}`bumpversion.functions` - -```{py:module} bumpversion.functions -``` - -```{autodoc2-docstring} bumpversion.functions -:allowtitles: -``` - -## Module Contents - -### Classes - -````{list-table} -:class: autosummary longtable -:align: left - -* - {py:obj}`PartFunction ` - - ```{autodoc2-docstring} bumpversion.functions.PartFunction - :summary: - ``` -* - {py:obj}`NumericFunction ` - - ```{autodoc2-docstring} bumpversion.functions.NumericFunction - :summary: - ``` -* - {py:obj}`ValuesFunction ` - - ```{autodoc2-docstring} bumpversion.functions.ValuesFunction - :summary: - ``` -```` - -### API - -`````{py:class} PartFunction -:canonical: bumpversion.functions.PartFunction - -```{autodoc2-docstring} bumpversion.functions.PartFunction -``` - -````{py:attribute} first_value -:canonical: bumpversion.functions.PartFunction.first_value -:type: str -:value: > - None - -```{autodoc2-docstring} bumpversion.functions.PartFunction.first_value -``` - -```` - -````{py:attribute} optional_value -:canonical: bumpversion.functions.PartFunction.optional_value -:type: str -:value: > - None - -```{autodoc2-docstring} bumpversion.functions.PartFunction.optional_value -``` - -```` - -````{py:attribute} independent -:canonical: bumpversion.functions.PartFunction.independent -:type: bool -:value: > - None - -```{autodoc2-docstring} bumpversion.functions.PartFunction.independent -``` - -```` - -````{py:method} bump(value: str) -> str -:canonical: bumpversion.functions.PartFunction.bump -:abstractmethod: - -```{autodoc2-docstring} bumpversion.functions.PartFunction.bump -``` - -```` - -````` - -`````{py:class} NumericFunction(optional_value: typing.Union[str, int, None] = None, first_value: typing.Union[str, int, None] = None) -:canonical: bumpversion.functions.NumericFunction - -Bases: {py:obj}`bumpversion.functions.PartFunction` - -```{autodoc2-docstring} bumpversion.functions.NumericFunction -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.functions.NumericFunction.__init__ -``` - -````{py:attribute} FIRST_NUMERIC -:canonical: bumpversion.functions.NumericFunction.FIRST_NUMERIC -:value: > - 'compile(...)' - -```{autodoc2-docstring} bumpversion.functions.NumericFunction.FIRST_NUMERIC -``` - -```` - -````{py:method} bump(value: typing.Union[str, int]) -> str -:canonical: bumpversion.functions.NumericFunction.bump - -```{autodoc2-docstring} bumpversion.functions.NumericFunction.bump -``` - -```` - -````` - -`````{py:class} ValuesFunction(values: typing.List[str], optional_value: typing.Optional[str] = None, first_value: typing.Optional[str] = None) -:canonical: bumpversion.functions.ValuesFunction - -Bases: {py:obj}`bumpversion.functions.PartFunction` - -```{autodoc2-docstring} bumpversion.functions.ValuesFunction -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.functions.ValuesFunction.__init__ -``` - -````{py:method} bump(value: str) -> str -:canonical: bumpversion.functions.ValuesFunction.bump - -```{autodoc2-docstring} bumpversion.functions.ValuesFunction.bump -``` - -```` - -````` diff --git a/_sources/reference/bumpversion/bumpversion.md.txt b/_sources/reference/bumpversion/bumpversion.md.txt index 751d43c1..936742fd 100644 --- a/_sources/reference/bumpversion/bumpversion.md.txt +++ b/_sources/reference/bumpversion/bumpversion.md.txt @@ -14,6 +14,7 @@ :maxdepth: 3 bumpversion.config +bumpversion.versioning ``` ## Submodules @@ -32,7 +33,6 @@ bumpversion.autocast bumpversion.files bumpversion.bump bumpversion.indented_logger -bumpversion.functions bumpversion.exceptions bumpversion.__main__ bumpversion.cli diff --git a/_sources/reference/bumpversion/bumpversion.utils.md.txt b/_sources/reference/bumpversion/bumpversion.utils.md.txt index 3b40d587..19b8ed47 100644 --- a/_sources/reference/bumpversion/bumpversion.utils.md.txt +++ b/_sources/reference/bumpversion/bumpversion.utils.md.txt @@ -101,7 +101,7 @@ ``` ```` -````{py:function} get_context(config: bumpversion.config.Config, current_version: typing.Optional[bumpversion.version_part.Version] = None, new_version: typing.Optional[bumpversion.version_part.Version] = None) -> collections.ChainMap +````{py:function} get_context(config: bumpversion.config.Config, current_version: typing.Optional[bumpversion.versioning.models.Version] = None, new_version: typing.Optional[bumpversion.versioning.models.Version] = None) -> collections.ChainMap :canonical: bumpversion.utils.get_context ```{autodoc2-docstring} bumpversion.utils.get_context diff --git a/_sources/reference/bumpversion/bumpversion.version_part.md.txt b/_sources/reference/bumpversion/bumpversion.version_part.md.txt index 4bb79466..7bd7c664 100644 --- a/_sources/reference/bumpversion/bumpversion.version_part.md.txt +++ b/_sources/reference/bumpversion/bumpversion.version_part.md.txt @@ -15,14 +15,6 @@ :class: autosummary longtable :align: left -* - {py:obj}`VersionPart ` - - ```{autodoc2-docstring} bumpversion.version_part.VersionPart - :summary: - ``` -* - {py:obj}`Version ` - - ```{autodoc2-docstring} bumpversion.version_part.Version - :summary: - ``` * - {py:obj}`VersionConfig ` - ```{autodoc2-docstring} bumpversion.version_part.VersionConfig :summary: @@ -53,143 +45,7 @@ ```` -`````{py:class} VersionPart(config: bumpversion.config.models.VersionPartConfig, value: typing.Union[str, int, None] = None) -:canonical: bumpversion.version_part.VersionPart - -```{autodoc2-docstring} bumpversion.version_part.VersionPart -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.__init__ -``` - -````{py:property} value -:canonical: bumpversion.version_part.VersionPart.value -:type: str - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.value -``` - -```` - -````{py:method} copy() -> bumpversion.version_part.VersionPart -:canonical: bumpversion.version_part.VersionPart.copy - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.copy -``` - -```` - -````{py:method} bump() -> bumpversion.version_part.VersionPart -:canonical: bumpversion.version_part.VersionPart.bump - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.bump -``` - -```` - -````{py:method} null() -> bumpversion.version_part.VersionPart -:canonical: bumpversion.version_part.VersionPart.null - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.null -``` - -```` - -````{py:property} is_optional -:canonical: bumpversion.version_part.VersionPart.is_optional -:type: bool - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.is_optional -``` - -```` - -````{py:property} is_independent -:canonical: bumpversion.version_part.VersionPart.is_independent -:type: bool - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.is_independent -``` - -```` - -````{py:method} __format__(format_spec: str) -> str -:canonical: bumpversion.version_part.VersionPart.__format__ - -```` - -````{py:method} __repr__() -> str -:canonical: bumpversion.version_part.VersionPart.__repr__ - -```` - -````{py:method} __eq__(other: typing.Any) -> bool -:canonical: bumpversion.version_part.VersionPart.__eq__ - -```` - -````` - -`````{py:class} Version(values: typing.Dict[str, bumpversion.version_part.VersionPart], original: typing.Optional[str] = None) -:canonical: bumpversion.version_part.Version - -```{autodoc2-docstring} bumpversion.version_part.Version -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.version_part.Version.__init__ -``` - -````{py:method} __getitem__(key: str) -> bumpversion.version_part.VersionPart -:canonical: bumpversion.version_part.Version.__getitem__ - -```{autodoc2-docstring} bumpversion.version_part.Version.__getitem__ -``` - -```` - -````{py:method} __len__() -> int -:canonical: bumpversion.version_part.Version.__len__ - -```{autodoc2-docstring} bumpversion.version_part.Version.__len__ -``` - -```` - -````{py:method} __iter__() -:canonical: bumpversion.version_part.Version.__iter__ - -```{autodoc2-docstring} bumpversion.version_part.Version.__iter__ -``` - -```` - -````{py:method} __repr__() -:canonical: bumpversion.version_part.Version.__repr__ - -```` - -````{py:method} __eq__(other: typing.Any) -> bool -:canonical: bumpversion.version_part.Version.__eq__ - -```` - -````{py:method} bump(part_name: str, order: typing.List[str]) -> bumpversion.version_part.Version -:canonical: bumpversion.version_part.Version.bump - -```{autodoc2-docstring} bumpversion.version_part.Version.bump -``` - -```` - -````` - -`````{py:class} VersionConfig(parse: str, serialize: typing.Tuple[str], search: str, replace: str, part_configs: typing.Optional[typing.Dict[str, bumpversion.config.models.VersionPartConfig]] = None) +`````{py:class} VersionConfig(parse: str, serialize: typing.Tuple[str], search: str, replace: str, part_configs: typing.Optional[typing.Dict[str, bumpversion.versioning.models.VersionComponentConfig]] = None) :canonical: bumpversion.version_part.VersionConfig ```{autodoc2-docstring} bumpversion.version_part.VersionConfig @@ -220,7 +76,7 @@ ```` -````{py:method} parse(version_string: typing.Optional[str] = None) -> typing.Optional[bumpversion.version_part.Version] +````{py:method} parse(version_string: typing.Optional[str] = None) -> typing.Optional[bumpversion.versioning.models.Version] :canonical: bumpversion.version_part.VersionConfig.parse ```{autodoc2-docstring} bumpversion.version_part.VersionConfig.parse @@ -228,23 +84,7 @@ ```` -````{py:method} _serialize(version: bumpversion.version_part.Version, serialize_format: str, context: typing.MutableMapping, raise_if_incomplete: bool = False) -> str -:canonical: bumpversion.version_part.VersionConfig._serialize - -```{autodoc2-docstring} bumpversion.version_part.VersionConfig._serialize -``` - -```` - -````{py:method} _choose_serialize_format(version: bumpversion.version_part.Version, context: typing.MutableMapping) -> str -:canonical: bumpversion.version_part.VersionConfig._choose_serialize_format - -```{autodoc2-docstring} bumpversion.version_part.VersionConfig._choose_serialize_format -``` - -```` - -````{py:method} serialize(version: bumpversion.version_part.Version, context: typing.MutableMapping) -> str +````{py:method} serialize(version: bumpversion.versioning.models.Version, context: typing.MutableMapping) -> str :canonical: bumpversion.version_part.VersionConfig.serialize ```{autodoc2-docstring} bumpversion.version_part.VersionConfig.serialize diff --git a/_sources/reference/bumpversion/bumpversion.versioning.conventions.md.txt b/_sources/reference/bumpversion/bumpversion.versioning.conventions.md.txt new file mode 100644 index 00000000..53212d4b --- /dev/null +++ b/_sources/reference/bumpversion/bumpversion.versioning.conventions.md.txt @@ -0,0 +1,132 @@ +# {py:mod}`bumpversion.versioning.conventions` + +```{py:module} bumpversion.versioning.conventions +``` + +```{autodoc2-docstring} bumpversion.versioning.conventions +:allowtitles: +``` + +## Module Contents + +### Functions + +````{list-table} +:class: autosummary longtable +:align: left + +* - {py:obj}`pep440_version_spec ` + - ```{autodoc2-docstring} bumpversion.versioning.conventions.pep440_version_spec + :summary: + ``` +* - {py:obj}`semver_spec ` + - ```{autodoc2-docstring} bumpversion.versioning.conventions.semver_spec + :summary: + ``` +```` + +### Data + +````{list-table} +:class: autosummary longtable +:align: left + +* - {py:obj}`PEP440_PATTERN ` + - ```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_PATTERN + :summary: + ``` +* - {py:obj}`PEP440_SERIALIZE_PATTERNS ` + - ```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS + :summary: + ``` +* - {py:obj}`PEP440_COMPONENT_CONFIGS ` + - ```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS + :summary: + ``` +* - {py:obj}`SEMVER_PATTERN ` + - ```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_PATTERN + :summary: + ``` +* - {py:obj}`SEMVER_SERIALIZE_PATTERNS ` + - ```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS + :summary: + ``` +* - {py:obj}`SEMVER_COMPONENT_CONFIGS ` + - ```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS + :summary: + ``` +```` + +### API + +````{py:data} PEP440_PATTERN +:canonical: bumpversion.versioning.conventions.PEP440_PATTERN +:value: + +```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_PATTERN +``` + +```` + +````{py:data} PEP440_SERIALIZE_PATTERNS +:canonical: bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS +:value: > + ['{major}.{minor}.{patch}{pre_l}{pre_n}.{post}.{dev}+{local}', '{major}.{minor}.{patch}{pre_l}{pre_n... + +```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS +``` + +```` + +````{py:data} PEP440_COMPONENT_CONFIGS +:canonical: bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS +``` + +```` + +````{py:function} pep440_version_spec() -> bumpversion.versioning.models.VersionSpec +:canonical: bumpversion.versioning.conventions.pep440_version_spec + +```{autodoc2-docstring} bumpversion.versioning.conventions.pep440_version_spec +``` +```` + +````{py:data} SEMVER_PATTERN +:canonical: bumpversion.versioning.conventions.SEMVER_PATTERN +:value: + +```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_PATTERN +``` + +```` + +````{py:data} SEMVER_SERIALIZE_PATTERNS +:canonical: bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS +:value: > + ['{major}.{minor}.{patch}-{pre_l}{pre_n}+{buildmetadata}', '{major}.{minor}.{patch}-{pre_l}{pre_n}',... + +```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS +``` + +```` + +````{py:data} SEMVER_COMPONENT_CONFIGS +:canonical: bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS +``` + +```` + +````{py:function} semver_spec() -> bumpversion.versioning.models.VersionSpec +:canonical: bumpversion.versioning.conventions.semver_spec + +```{autodoc2-docstring} bumpversion.versioning.conventions.semver_spec +``` +```` diff --git a/_sources/reference/bumpversion/bumpversion.versioning.functions.md.txt b/_sources/reference/bumpversion/bumpversion.versioning.functions.md.txt new file mode 100644 index 00000000..47f12732 --- /dev/null +++ b/_sources/reference/bumpversion/bumpversion.versioning.functions.md.txt @@ -0,0 +1,168 @@ +# {py:mod}`bumpversion.versioning.functions` + +```{py:module} bumpversion.versioning.functions +``` + +```{autodoc2-docstring} bumpversion.versioning.functions +:allowtitles: +``` + +## Module Contents + +### Classes + +````{list-table} +:class: autosummary longtable +:align: left + +* - {py:obj}`PartFunction ` + - ```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction + :summary: + ``` +* - {py:obj}`IndependentFunction ` + - ```{autodoc2-docstring} bumpversion.versioning.functions.IndependentFunction + :summary: + ``` +* - {py:obj}`NumericFunction ` + - ```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction + :summary: + ``` +* - {py:obj}`ValuesFunction ` + - ```{autodoc2-docstring} bumpversion.versioning.functions.ValuesFunction + :summary: + ``` +```` + +### API + +`````{py:class} PartFunction +:canonical: bumpversion.versioning.functions.PartFunction + +```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction +``` + +````{py:attribute} first_value +:canonical: bumpversion.versioning.functions.PartFunction.first_value +:type: str +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction.first_value +``` + +```` + +````{py:attribute} optional_value +:canonical: bumpversion.versioning.functions.PartFunction.optional_value +:type: str +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction.optional_value +``` + +```` + +````{py:attribute} independent +:canonical: bumpversion.versioning.functions.PartFunction.independent +:type: bool +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction.independent +``` + +```` + +````{py:method} bump(value: str) -> str +:canonical: bumpversion.versioning.functions.PartFunction.bump +:abstractmethod: + +```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction.bump +``` + +```` + +````` + +`````{py:class} IndependentFunction(value: typing.Union[str, int, None] = None) +:canonical: bumpversion.versioning.functions.IndependentFunction + +Bases: {py:obj}`bumpversion.versioning.functions.PartFunction` + +```{autodoc2-docstring} bumpversion.versioning.functions.IndependentFunction +``` + +```{rubric} Initialization +``` + +```{autodoc2-docstring} bumpversion.versioning.functions.IndependentFunction.__init__ +``` + +````{py:method} bump(value: typing.Optional[str] = None) -> str +:canonical: bumpversion.versioning.functions.IndependentFunction.bump + +```{autodoc2-docstring} bumpversion.versioning.functions.IndependentFunction.bump +``` + +```` + +````` + +`````{py:class} NumericFunction(optional_value: typing.Union[str, int, None] = None, first_value: typing.Union[str, int, None] = None) +:canonical: bumpversion.versioning.functions.NumericFunction + +Bases: {py:obj}`bumpversion.versioning.functions.PartFunction` + +```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction +``` + +```{rubric} Initialization +``` + +```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction.__init__ +``` + +````{py:attribute} FIRST_NUMERIC +:canonical: bumpversion.versioning.functions.NumericFunction.FIRST_NUMERIC +:value: > + 'compile(...)' + +```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction.FIRST_NUMERIC +``` + +```` + +````{py:method} bump(value: typing.Union[str, int]) -> str +:canonical: bumpversion.versioning.functions.NumericFunction.bump + +```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction.bump +``` + +```` + +````` + +`````{py:class} ValuesFunction(values: typing.List[str], optional_value: typing.Optional[str] = None, first_value: typing.Optional[str] = None) +:canonical: bumpversion.versioning.functions.ValuesFunction + +Bases: {py:obj}`bumpversion.versioning.functions.PartFunction` + +```{autodoc2-docstring} bumpversion.versioning.functions.ValuesFunction +``` + +```{rubric} Initialization +``` + +```{autodoc2-docstring} bumpversion.versioning.functions.ValuesFunction.__init__ +``` + +````{py:method} bump(value: str) -> str +:canonical: bumpversion.versioning.functions.ValuesFunction.bump + +```{autodoc2-docstring} bumpversion.versioning.functions.ValuesFunction.bump +``` + +```` + +````` diff --git a/_sources/reference/bumpversion/bumpversion.versioning.md.txt b/_sources/reference/bumpversion/bumpversion.versioning.md.txt new file mode 100644 index 00000000..1bef3a9c --- /dev/null +++ b/_sources/reference/bumpversion/bumpversion.versioning.md.txt @@ -0,0 +1,20 @@ +# {py:mod}`bumpversion.versioning` + +```{py:module} bumpversion.versioning +``` + +```{autodoc2-docstring} bumpversion.versioning +:allowtitles: +``` + +## Submodules + +```{toctree} +:titlesonly: +:maxdepth: 1 + +bumpversion.versioning.conventions +bumpversion.versioning.functions +bumpversion.versioning.models +bumpversion.versioning.serialization +``` diff --git a/_sources/reference/bumpversion/bumpversion.versioning.models.md.txt b/_sources/reference/bumpversion/bumpversion.versioning.models.md.txt new file mode 100644 index 00000000..1aa531e4 --- /dev/null +++ b/_sources/reference/bumpversion/bumpversion.versioning.models.md.txt @@ -0,0 +1,297 @@ +# {py:mod}`bumpversion.versioning.models` + +```{py:module} bumpversion.versioning.models +``` + +```{autodoc2-docstring} bumpversion.versioning.models +:allowtitles: +``` + +## Module Contents + +### Classes + +````{list-table} +:class: autosummary longtable +:align: left + +* - {py:obj}`VersionComponent ` + - ```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent + :summary: + ``` +* - {py:obj}`VersionComponentConfig ` + - ```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig + :summary: + ``` +* - {py:obj}`VersionSpec ` + - ```{autodoc2-docstring} bumpversion.versioning.models.VersionSpec + :summary: + ``` +* - {py:obj}`Version ` + - ```{autodoc2-docstring} bumpversion.versioning.models.Version + :summary: + ``` +```` + +### API + +`````{py:class} VersionComponent(values: typing.Optional[list] = None, optional_value: typing.Optional[str] = None, first_value: typing.Union[str, int, None] = None, independent: bool = False, source: typing.Optional[str] = None, value: typing.Union[str, int, None] = None) +:canonical: bumpversion.versioning.models.VersionComponent + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent +``` + +```{rubric} Initialization +``` + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent.__init__ +``` + +````{py:property} value +:canonical: bumpversion.versioning.models.VersionComponent.value +:type: str + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent.value +``` + +```` + +````{py:method} copy() -> bumpversion.versioning.models.VersionComponent +:canonical: bumpversion.versioning.models.VersionComponent.copy + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent.copy +``` + +```` + +````{py:method} bump() -> bumpversion.versioning.models.VersionComponent +:canonical: bumpversion.versioning.models.VersionComponent.bump + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent.bump +``` + +```` + +````{py:method} null() -> bumpversion.versioning.models.VersionComponent +:canonical: bumpversion.versioning.models.VersionComponent.null + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent.null +``` + +```` + +````{py:property} is_optional +:canonical: bumpversion.versioning.models.VersionComponent.is_optional +:type: bool + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent.is_optional +``` + +```` + +````{py:property} is_independent +:canonical: bumpversion.versioning.models.VersionComponent.is_independent +:type: bool + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponent.is_independent +``` + +```` + +````{py:method} __format__(format_spec: str) -> str +:canonical: bumpversion.versioning.models.VersionComponent.__format__ + +```` + +````{py:method} __repr__() -> str +:canonical: bumpversion.versioning.models.VersionComponent.__repr__ + +```` + +````{py:method} __eq__(other: typing.Any) -> bool +:canonical: bumpversion.versioning.models.VersionComponent.__eq__ + +```` + +````` + +`````{py:class} VersionComponentConfig(**data: typing.Any) +:canonical: bumpversion.versioning.models.VersionComponentConfig + +Bases: {py:obj}`pydantic.BaseModel` + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig +``` + +```{rubric} Initialization +``` + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig.__init__ +``` + +````{py:attribute} values +:canonical: bumpversion.versioning.models.VersionComponentConfig.values +:type: typing.Optional[list] +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig.values +``` + +```` + +````{py:attribute} optional_value +:canonical: bumpversion.versioning.models.VersionComponentConfig.optional_value +:type: typing.Optional[str] +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig.optional_value +``` + +```` + +````{py:attribute} first_value +:canonical: bumpversion.versioning.models.VersionComponentConfig.first_value +:type: typing.Union[str, int, None] +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig.first_value +``` + +```` + +````{py:attribute} independent +:canonical: bumpversion.versioning.models.VersionComponentConfig.independent +:type: bool +:value: > + False + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig.independent +``` + +```` + +````{py:attribute} depends_on +:canonical: bumpversion.versioning.models.VersionComponentConfig.depends_on +:type: typing.Optional[str] +:value: > + None + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig.depends_on +``` + +```` + +````{py:method} create_component(value: typing.Union[str, int, None] = None) -> bumpversion.versioning.models.VersionComponent +:canonical: bumpversion.versioning.models.VersionComponentConfig.create_component + +```{autodoc2-docstring} bumpversion.versioning.models.VersionComponentConfig.create_component +``` + +```` + +````` + +`````{py:class} VersionSpec(components: typing.Dict[str, bumpversion.versioning.models.VersionComponentConfig], order: typing.Optional[typing.List[str]] = None) +:canonical: bumpversion.versioning.models.VersionSpec + +```{autodoc2-docstring} bumpversion.versioning.models.VersionSpec +``` + +```{rubric} Initialization +``` + +```{autodoc2-docstring} bumpversion.versioning.models.VersionSpec.__init__ +``` + +````{py:method} create_version(values: typing.Dict[str, str]) -> bumpversion.versioning.models.Version +:canonical: bumpversion.versioning.models.VersionSpec.create_version + +```{autodoc2-docstring} bumpversion.versioning.models.VersionSpec.create_version +``` + +```` + +````{py:method} get_dependents(component_name: str) -> typing.List[str] +:canonical: bumpversion.versioning.models.VersionSpec.get_dependents + +```{autodoc2-docstring} bumpversion.versioning.models.VersionSpec.get_dependents +``` + +```` + +````` + +`````{py:class} Version(version_spec: bumpversion.versioning.models.VersionSpec, components: typing.Dict[str, bumpversion.versioning.models.VersionComponent], original: typing.Optional[str] = None) +:canonical: bumpversion.versioning.models.Version + +```{autodoc2-docstring} bumpversion.versioning.models.Version +``` + +```{rubric} Initialization +``` + +```{autodoc2-docstring} bumpversion.versioning.models.Version.__init__ +``` + +````{py:method} values() -> typing.Dict[str, str] +:canonical: bumpversion.versioning.models.Version.values + +```{autodoc2-docstring} bumpversion.versioning.models.Version.values +``` + +```` + +````{py:method} __getitem__(key: str) -> bumpversion.versioning.models.VersionComponent +:canonical: bumpversion.versioning.models.Version.__getitem__ + +```{autodoc2-docstring} bumpversion.versioning.models.Version.__getitem__ +``` + +```` + +````{py:method} __len__() -> int +:canonical: bumpversion.versioning.models.Version.__len__ + +```{autodoc2-docstring} bumpversion.versioning.models.Version.__len__ +``` + +```` + +````{py:method} __iter__() +:canonical: bumpversion.versioning.models.Version.__iter__ + +```{autodoc2-docstring} bumpversion.versioning.models.Version.__iter__ +``` + +```` + +````{py:method} __repr__() +:canonical: bumpversion.versioning.models.Version.__repr__ + +```` + +````{py:method} __eq__(other: typing.Any) -> bool +:canonical: bumpversion.versioning.models.Version.__eq__ + +```` + +````{py:method} required_components() -> typing.List[str] +:canonical: bumpversion.versioning.models.Version.required_components + +```{autodoc2-docstring} bumpversion.versioning.models.Version.required_components +``` + +```` + +````{py:method} bump(component_name: str) -> bumpversion.versioning.models.Version +:canonical: bumpversion.versioning.models.Version.bump + +```{autodoc2-docstring} bumpversion.versioning.models.Version.bump +``` + +```` + +````` diff --git a/_sources/reference/bumpversion/bumpversion.versioning.serialization.md.txt b/_sources/reference/bumpversion/bumpversion.versioning.serialization.md.txt new file mode 100644 index 00000000..b4ae5e76 --- /dev/null +++ b/_sources/reference/bumpversion/bumpversion.versioning.serialization.md.txt @@ -0,0 +1,75 @@ +# {py:mod}`bumpversion.versioning.serialization` + +```{py:module} bumpversion.versioning.serialization +``` + +```{autodoc2-docstring} bumpversion.versioning.serialization +:allowtitles: +``` + +## Module Contents + +### Functions + +````{list-table} +:class: autosummary longtable +:align: left + +* - {py:obj}`parse_version ` + - ```{autodoc2-docstring} bumpversion.versioning.serialization.parse_version + :summary: + ``` +* - {py:obj}`multisort ` + - ```{autodoc2-docstring} bumpversion.versioning.serialization.multisort + :summary: + ``` +* - {py:obj}`serialize ` + - ```{autodoc2-docstring} bumpversion.versioning.serialization.serialize + :summary: + ``` +```` + +### Data + +````{list-table} +:class: autosummary longtable +:align: left + +* - {py:obj}`logger ` + - ```{autodoc2-docstring} bumpversion.versioning.serialization.logger + :summary: + ``` +```` + +### API + +````{py:data} logger +:canonical: bumpversion.versioning.serialization.logger +:value: > + 'get_indented_logger(...)' + +```{autodoc2-docstring} bumpversion.versioning.serialization.logger +``` + +```` + +````{py:function} parse_version(version_string: str, parse_pattern: str) -> typing.Dict[str, str] +:canonical: bumpversion.versioning.serialization.parse_version + +```{autodoc2-docstring} bumpversion.versioning.serialization.parse_version +``` +```` + +````{py:function} multisort(xs: list, specs: tuple) -> list +:canonical: bumpversion.versioning.serialization.multisort + +```{autodoc2-docstring} bumpversion.versioning.serialization.multisort +``` +```` + +````{py:function} serialize(version: bumpversion.versioning.models.Version, serialize_patterns: typing.List[str], context: typing.MutableMapping) -> str +:canonical: bumpversion.versioning.serialization.serialize + +```{autodoc2-docstring} bumpversion.versioning.serialization.serialize +``` +```` diff --git a/changelog.html b/changelog.html index 1f3767f0..604febbd 100644 --- a/changelog.html +++ b/changelog.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/contributing.html b/contributing.html index 03b36c6d..e63b80be 100644 --- a/contributing.html +++ b/contributing.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/explanation/index.html b/explanation/index.html index 0cc587f0..237abd6c 100644 --- a/explanation/index.html +++ b/explanation/index.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/genindex.html b/genindex.html index ad313bd2..0033674d 100644 --- a/genindex.html +++ b/genindex.html @@ -183,6 +183,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -193,7 +200,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -203,7 +209,7 @@ -
  • Explanation @@ -248,23 +254,23 @@

    Index

    _

    - + - + @@ -750,6 +788,8 @@

    G

  • get_context() (in module bumpversion.utils)
  • get_defaults_from_dest() (in module bumpversion.config.create) +
    • +
  • get_dependents() (bumpversion.versioning.models.VersionSpec method)
  • get_file_contents() (bumpversion.files.ConfiguredFile method)
    • @@ -795,21 +835,23 @@

    I

  • indent_str (bumpversion.indented_logger.IndentedLoggerAdapter property)
    • - - + @@ -932,8 +976,6 @@

    M

  • bumpversion.exceptions
  • bumpversion.files -
    • -
  • bumpversion.functions
  • bumpversion.indented_logger
    • @@ -946,6 +988,16 @@

    M

  • bumpversion.utils
  • bumpversion.version_part +
    • +
  • bumpversion.versioning +
    • +
  • bumpversion.versioning.conventions +
    • +
  • bumpversion.versioning.functions +
    • +
  • bumpversion.versioning.models +
    • +
  • bumpversion.versioning.serialization
  • bumpversion.visualize
    • @@ -953,6 +1005,10 @@

    M

    +
  • __str__() (bumpversion.files.ConfiguredFile method) @@ -300,8 +306,6 @@

    _

  • (bumpversion.scm.SourceCodeManager attribute)
    • -
  • _choose_serialize_format() (bumpversion.version_part.VersionConfig method) -
  • _COMMIT_COMMAND (bumpversion.scm.Git attribute)
    • bumpversion.config.files_legacy @@ -477,6 +479,8 @@

      B

    • module
    +
    • bumpversion.config.utils @@ -496,13 +500,6 @@

      B

      • -
    • - bumpversion.functions - -
    • @@ -545,6 +542,41 @@

      B

      • +
    • + bumpversion.versioning + +
      • +
    • + bumpversion.versioning.conventions + +
      • +
    • + bumpversion.versioning.functions + +
      • +
    • + bumpversion.versioning.models + +
      • +
    • + bumpversion.versioning.serialization + +
    • @@ -595,13 +627,13 @@

      C

    • ConfiguredFile (class in bumpversion.files)
      • -
    @@ -964,9 +1020,9 @@

    N

    • @@ -976,10 +1032,10 @@

    N

    O

  • parse() (bumpversion.version_part.VersionConfig method)
    • -
  • PartFunction (class in bumpversion.functions) +
  • parse_version() (in module bumpversion.versioning.serialization) +
    • +
  • PartFunction (class in bumpversion.versioning.functions)
  • parts (bumpversion.config.models.Config attribute) +
    • +
  • PEP440_COMPONENT_CONFIGS (in module bumpversion.versioning.conventions) +
    • +
  • PEP440_PATTERN (in module bumpversion.versioning.conventions)
    		• +
  • SEMVER_COMPONENT_CONFIGS (in module bumpversion.versioning.conventions) +
    • +
  • SEMVER_PATTERN (in module bumpversion.versioning.conventions) +
    • +
  • SEMVER_SERIALIZE_PATTERNS (in module bumpversion.versioning.conventions) +
    • +
  • semver_spec() (in module bumpversion.versioning.conventions) +
  • serialize (bumpversion.config.models.Config attribute)
    • -
  • serialize() (bumpversion.version_part.VersionConfig method) -
    		•  +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/bumpversion/bumpversion.config.create.html b/reference/bumpversion/bumpversion.config.create.html index bdcafc8c..cb2c27d9 100644 --- a/reference/bumpversion/bumpversion.config.create.html +++ b/reference/bumpversion/bumpversion.config.create.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/bumpversion/bumpversion.config.files.html b/reference/bumpversion/bumpversion.config.files.html index 9bf77c67..fdb21482 100644 --- a/reference/bumpversion/bumpversion.config.files.html +++ b/reference/bumpversion/bumpversion.config.files.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -333,7 +339,7 @@

    API#

    -bumpversion.config.files.update_config_file(config_file: Union[str, pathlib.Path], config: bumpversion.config.models.Config, current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: MutableMapping, dry_run: bool = False) → None[source]#
    +bumpversion.config.files.update_config_file(config_file: Union[str, pathlib.Path], config: bumpversion.config.models.Config, current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: MutableMapping, dry_run: bool = False) → None[source]#

    Update the current_version key in the configuration file.

    Args: config_file: The configuration file to explicitly use. diff --git a/reference/bumpversion/bumpversion.config.files_legacy.html b/reference/bumpversion/bumpversion.config.files_legacy.html index 044fd1b2..c6b01a17 100644 --- a/reference/bumpversion/bumpversion.config.files_legacy.html +++ b/reference/bumpversion/bumpversion.config.files_legacy.html @@ -3,7 +3,7 @@ - + bumpversion.config.files_legacy - Bump My Version 0.17.1 @@ -185,6 +185,13 @@

  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -315,12 +321,12 @@

    API#

    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/bumpversion/bumpversion.config.models.html b/reference/bumpversion/bumpversion.config.models.html index b7d0400e..18722c43 100644 --- a/reference/bumpversion/bumpversion.config.models.html +++ b/reference/bumpversion/bumpversion.config.models.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -252,13 +258,10 @@

    Classes#<
    - - - - + - + @@ -285,43 +288,6 @@

    API#

    ‘get_indented_logger(…)’

    -
    -
    -class bumpversion.config.models.VersionPartConfig(**data: Any)[source]#
    -

    Bases: pydantic.BaseModel

    -

    Configuration of a part of the version.

    -

    Initialization

    -

    Create a new model by parsing and validating input data from keyword arguments.

    -

    Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be -validated to form a valid model.

    -

    __init__ uses __pydantic_self__ instead of the more common self for the first arg to -allow self as a field name.

    -
    -
    -values: Optional[list]#
    -

    None

    -
    - -
    -
    -optional_value: Optional[str]#
    -

    None

    -
    - -
    -
    -first_value: Union[str, int, None]#
    -

    None

    -
    - -
    -
    -independent: bool#
    -

    False

    -
    - -
    -
    class bumpversion.config.models.FileChange(**data: Any)[source]#
    @@ -514,7 +480,7 @@

    API#

    -parts: Dict[str, bumpversion.config.models.VersionPartConfig]#
    +parts: Dict[str, bumpversion.versioning.models.VersionComponentConfig]#

    None

    @@ -578,6 +544,12 @@

    API#

    Return the version configuration.

    +
    +
    +version_spec(version: Optional[str] = None) → bumpversion.versioning.models.VersionSpec[source]#
    +

    Return the version specification.

    +
    + @@ -652,13 +624,6 @@

    API#

  • Data
  • API diff --git a/reference/bumpversion/bumpversion.config.utils.html b/reference/bumpversion/bumpversion.config.utils.html index ee233396..b9e51f01 100644 --- a/reference/bumpversion/bumpversion.config.utils.html +++ b/reference/bumpversion/bumpversion.config.utils.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -275,7 +281,7 @@

    API#

    -bumpversion.config.utils.get_all_part_configs(config_dict: dict) → Dict[str, bumpversion.config.models.VersionPartConfig][source]#
    +bumpversion.config.utils.get_all_part_configs(config_dict: dict) → Dict[str, bumpversion.versioning.models.VersionComponentConfig][source]#

    Make sure all version parts are included.

    diff --git a/reference/bumpversion/bumpversion.exceptions.html b/reference/bumpversion/bumpversion.exceptions.html index b1ade1f2..f1d3c900 100644 --- a/reference/bumpversion/bumpversion.exceptions.html +++ b/reference/bumpversion/bumpversion.exceptions.html @@ -3,7 +3,7 @@ - + bumpversion.exceptions - Bump My Version 0.17.1 @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -348,14 +354,14 @@

    API#

    - +
    Previous
    -
    bumpversion.functions
    +
    bumpversion.indented_logger
     diff --git a/reference/bumpversion/bumpversion.files.html b/reference/bumpversion/bumpversion.files.html index 3a69b1f5..98c0fade 100644 --- a/reference/bumpversion/bumpversion.files.html +++ b/reference/bumpversion/bumpversion.files.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -346,7 +352,7 @@

    API#

    -_contains_change_pattern(search_expression: re.Pattern, raw_search_expression: str, version: bumpversion.version_part.Version, context: MutableMapping) → bool[source]#
    +_contains_change_pattern(search_expression: re.Pattern, raw_search_expression: str, version: bumpversion.versioning.models.Version, context: MutableMapping) → bool[source]#

    Does the file contain the change pattern?

    Args: search_expression: The compiled search expression @@ -361,7 +367,7 @@

    API#

    -make_file_change(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: MutableMapping, dry_run: bool = False) → None[source]#
    +make_file_change(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: MutableMapping, dry_run: bool = False) → None[source]#

    Make the change to the file.

    @@ -392,7 +398,7 @@

    API#

    -bumpversion.files.modify_files(files: List[bumpversion.files.ConfiguredFile], current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: MutableMapping, dry_run: bool = False) → None[source]#
    +bumpversion.files.modify_files(files: List[bumpversion.files.ConfiguredFile], current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: MutableMapping, dry_run: bool = False) → None[source]#

    Modify the files, searching and replacing values according to the FileConfig.

    Args: files: The list of configured files @@ -409,7 +415,7 @@

    API#

    Initialization

    -update_file(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: MutableMapping, dry_run: bool = False) → None[source]#
    +update_file(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: MutableMapping, dry_run: bool = False) → None[source]#

    Update the files.

    @@ -417,12 +423,12 @@

    API#

    -class bumpversion.files.DataFileUpdater(file_change: bumpversion.config.models.FileChange, version_part_configs: Dict[str, bumpversion.config.models.VersionPartConfig])[source]#
    +class bumpversion.files.DataFileUpdater(file_change: bumpversion.config.models.FileChange, version_part_configs: Dict[str, bumpversion.versioning.models.VersionComponentConfig])[source]#

    A class to handle updating files.

    Initialization

    -update_file(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: MutableMapping, dry_run: bool = False) → None[source]#
    +update_file(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: MutableMapping, dry_run: bool = False) → None[source]#

    Update the files.

    diff --git a/reference/bumpversion/bumpversion.html b/reference/bumpversion/bumpversion.html index 094bba18..a3da7887 100644 --- a/reference/bumpversion/bumpversion.html +++ b/reference/bumpversion/bumpversion.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -257,6 +263,13 @@

    Subpackagesbumpversion.config.files_legacy

    • +
  • bumpversion.versioning +
    • @@ -274,7 +287,6 @@

    Submodulesbumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • diff --git a/reference/bumpversion/bumpversion.indented_logger.html b/reference/bumpversion/bumpversion.indented_logger.html index 2dccf6ec..cadcfd98 100644 --- a/reference/bumpversion/bumpversion.indented_logger.html +++ b/reference/bumpversion/bumpversion.indented_logger.html @@ -3,7 +3,7 @@ - + bumpversion.indented_logger - Bump My Version 0.17.1 @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -349,12 +355,12 @@

    API#

    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/bumpversion/bumpversion.show.html b/reference/bumpversion/bumpversion.show.html index 17d991c5..cff0ba15 100644 --- a/reference/bumpversion/bumpversion.show.html +++ b/reference/bumpversion/bumpversion.show.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/bumpversion/bumpversion.ui.html b/reference/bumpversion/bumpversion.ui.html index 48e3dde4..18d16925 100644 --- a/reference/bumpversion/bumpversion.ui.html +++ b/reference/bumpversion/bumpversion.ui.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/bumpversion/bumpversion.utils.html b/reference/bumpversion/bumpversion.utils.html index 1dbb20f1..30b15ba3 100644 --- a/reference/bumpversion/bumpversion.utils.html +++ b/reference/bumpversion/bumpversion.utils.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -330,7 +336,7 @@

    API#

    -bumpversion.utils.get_context(config: bumpversion.config.Config, current_version: Optional[bumpversion.version_part.Version] = None, new_version: Optional[bumpversion.version_part.Version] = None) → collections.ChainMap[source]#
    +bumpversion.utils.get_context(config: bumpversion.config.Config, current_version: Optional[bumpversion.versioning.models.Version] = None, new_version: Optional[bumpversion.versioning.models.Version] = None) → collections.ChainMap[source]#

    Return the context for rendering messages and tags.

    diff --git a/reference/bumpversion/bumpversion.version_part.html b/reference/bumpversion/bumpversion.version_part.html index d29384f2..f7f28177 100644 --- a/reference/bumpversion/bumpversion.version_part.html +++ b/reference/bumpversion/bumpversion.version_part.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -252,12 +258,6 @@

    Classes#<

    • VersionPartConfig

    Configuration of a part of the version.

    FileChange

    FileChange

    A change to make to a file.

    Config

    Config

    Bump Version configuration.
    - - - - - - @@ -285,107 +285,9 @@

    API#

    ‘get_indented_logger(…)’

    -
    -
    -class bumpversion.version_part.VersionPart(config: bumpversion.config.models.VersionPartConfig, value: Union[str, int, None] = None)[source]#
    -

    Represent part of a version number.

    -

    Determines the PartFunction that rules how the part behaves when increased or reset -based on the configuration given.

    -

    Initialization

    -
    -
    -property value: str#
    -

    Return the value of the part.

    -
    - -
    -
    -copy() → bumpversion.version_part.VersionPart[source]#
    -

    Return a copy of the part.

    -
    - -
    -
    -bump() → bumpversion.version_part.VersionPart[source]#
    -

    Return a part with bumped value.

    -
    - -
    -
    -null() → bumpversion.version_part.VersionPart[source]#
    -

    Return a part with first value.

    -
    - -
    -
    -property is_optional: bool#
    -

    Is the part optional?

    -
    - -
    -
    -property is_independent: bool#
    -

    Is the part independent of the other parts?

    -
    - -
    -
    -__format__(format_spec: str) → str[source]#
    -
    - -
    -
    -__repr__() → str[source]#
    -
    - -
    -
    -__eq__(other: Any) → bool[source]#
    -
    - -
    - -
    -
    -class bumpversion.version_part.Version(values: Dict[str, bumpversion.version_part.VersionPart], original: Optional[str] = None)[source]#
    -

    The specification of a version and its parts.

    -

    Initialization

    -
    -
    -__getitem__(key: str) → bumpversion.version_part.VersionPart[source]#
    -
    - -
    -
    -__len__() → int[source]#
    -
    - -
    -
    -__iter__()[source]#
    -
    - -
    -
    -__repr__()[source]#
    -
    - -
    -
    -__eq__(other: Any) → bool[source]#
    -
    - -
    -
    -bump(part_name: str, order: List[str]) → bumpversion.version_part.Version[source]#
    -

    Increase the value of the given part.

    -
    - -
    -
    -class bumpversion.version_part.VersionConfig(parse: str, serialize: Tuple[str], search: str, replace: str, part_configs: Optional[Dict[str, bumpversion.config.models.VersionPartConfig]] = None)[source]#
    +class bumpversion.version_part.VersionConfig(parse: str, serialize: Tuple[str], search: str, replace: str, part_configs: Optional[Dict[str, bumpversion.versioning.models.VersionComponentConfig]] = None)[source]#

    Hold a complete representation of a version string.

    Initialization

    @@ -410,7 +312,7 @@

    API#

    -parse(version_string: Optional[str] = None) → Optional[bumpversion.version_part.Version][source]#
    +parse(version_string: Optional[str] = None) → Optional[bumpversion.versioning.models.Version][source]#

    Parse a version string into a Version object.

    Args: version_string: Version string to parse

    @@ -418,30 +320,9 @@

    API#

    A Version object representing the string.

    -
    -
    -_serialize(version: bumpversion.version_part.Version, serialize_format: str, context: MutableMapping, raise_if_incomplete: bool = False) → str[source]#
    -

    Attempts to serialize a version with the given serialization format.

    -

    Args: -version: The version to serialize -serialize_format: The serialization format to use, using Python’s format string syntax -context: The context to use when serializing the version -raise_if_incomplete: Whether to raise an error if the version is incomplete

    -

    Raises: -FormattingError: if not serializable -MissingValueError: if not all parts required in the format have values

    -

    Returns: -The serialized version as a string

    -
    - -
    -
    -_choose_serialize_format(version: bumpversion.version_part.Version, context: MutableMapping) → str[source]#
    -
    -
    -serialize(version: bumpversion.version_part.Version, context: MutableMapping) → str[source]#
    +serialize(version: bumpversion.versioning.models.Version, context: MutableMapping) → str[source]#

    Serialize a version to a string.

    Args: version: The version to serialize @@ -524,34 +405,11 @@

    API#

  • Data
  • API

    • VersionPart

    Represent part of a version number.

    Version

    The specification of a version and its parts.

    VersionConfig

    Hold a complete representation of a version string.
    + + + + + + + + +

    pep440_version_spec

    Return a VersionSpec for PEP 440.

    semver_spec

    Return a VersionSpec for SEMVER.

    +
     + +
    +

    Data#

    +
    + + + + + + + + + + + + + + + + + + + + + +

    PEP440_PATTERN

    PEP440_SERIALIZE_PATTERNS

    PEP440_COMPONENT_CONFIGS

    SEMVER_PATTERN

    SEMVER_SERIALIZE_PATTERNS

    SEMVER_COMPONENT_CONFIGS

    +
    +
    +
    +

    API#

    +
    +
    +bumpversion.versioning.conventions.PEP440_PATTERN = <Multiline-String>#
    +
    + +
    +
    +bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS#
    +

    [‘{major}.{minor}.{patch}{pre_l}{pre_n}.{post}.{dev}+{local}’, ‘{major}.{minor}.{patch}{pre_l}{pre_n…

    +
    + +
    +
    +bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS#
    +

    None

    +
    + +
    +
    +bumpversion.versioning.conventions.pep440_version_spec() → bumpversion.versioning.models.VersionSpec[source]#
    +

    Return a VersionSpec for PEP 440.

    +
    + +
    +
    +bumpversion.versioning.conventions.SEMVER_PATTERN = <Multiline-String>#
    +
    + +
    +
    +bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS#
    +

    [‘{major}.{minor}.{patch}-{pre_l}{pre_n}+{buildmetadata}’, ‘{major}.{minor}.{patch}-{pre_l}{pre_n}’,…

    +
    + +
    +
    +bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS#
    +

    None

    +
    + +
    +
    +bumpversion.versioning.conventions.semver_spec() → bumpversion.versioning.models.VersionSpec[source]#
    +

    Return a VersionSpec for SEMVER.

    +
    + +
    + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/reference/bumpversion/bumpversion.functions.html b/reference/bumpversion/bumpversion.versioning.functions.html similarity index 60% rename from reference/bumpversion/bumpversion.functions.html rename to reference/bumpversion/bumpversion.versioning.functions.html index 3605e271..6348179b 100644 --- a/reference/bumpversion/bumpversion.functions.html +++ b/reference/bumpversion/bumpversion.versioning.functions.html @@ -3,10 +3,10 @@ - + - bumpversion.functions - Bump My Version 0.17.1 + bumpversion.versioning.functions - Bump My Version 0.17.1 @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy

    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -242,8 +248,8 @@
    -
    -

    bumpversion.functions#

    +
    +

    bumpversion.versioning.functions#

    Generators for version parts.

    Module Contents#

    @@ -252,13 +258,16 @@

    Classes#<
    - + - + + + + - + @@ -268,39 +277,54 @@

    Classes#<

    API#

    -
    -class bumpversion.functions.PartFunction[source]#
    +
    +class bumpversion.versioning.functions.PartFunction[source]#

    Base class for a version part function.

    -
    -first_value: str#
    +
    +first_value: str#

    None

    -
    -optional_value: str#
    +
    +optional_value: str#

    None

    -
    -independent: bool#
    +
    +independent: bool#

    None

    -
    -abstract bump(value: str) → str[source]#
    +
    +abstract bump(value: str) → str[source]#

    Increase the value.

    -
    -class bumpversion.functions.NumericFunction(optional_value: Union[str, int, None] = None, first_value: Union[str, int, None] = None)[source]#
    -

    Bases: bumpversion.functions.PartFunction

    +
    +class bumpversion.versioning.functions.IndependentFunction(value: Union[str, int, None] = None)[source]#
    +

    Bases: bumpversion.versioning.functions.PartFunction

    +

    This is a class that provides an independent function for version parts.

    +

    It simply returns the optional value, which is equal to the first value.

    +

    Initialization

    +
    +
    +bump(value: Optional[str] = None) → str[source]#
    +

    Return the optional value.

    +
    + +
    + +
    +
    +class bumpversion.versioning.functions.NumericFunction(optional_value: Union[str, int, None] = None, first_value: Union[str, int, None] = None)[source]#
    +

    Bases: bumpversion.versioning.functions.PartFunction

    This is a class that provides a numeric function for version parts.

    It simply starts with the provided first_value (0 by default) and increases it following the sequence of integer numbers.

    @@ -310,23 +334,23 @@

    API#

    considered (e.g. ‘r3-001’ –> ‘r4-001’).

    Initialization

    -
    -FIRST_NUMERIC#
    +
    +FIRST_NUMERIC#

    ‘compile(…)’

    -
    -bump(value: Union[str, int]) → str[source]#
    +
    +bump(value: Union[str, int]) → str[source]#

    Increase the first numerical value by one.

    -
    -class bumpversion.functions.ValuesFunction(values: List[str], optional_value: Optional[str] = None, first_value: Optional[str] = None)[source]#
    -

    Bases: bumpversion.functions.PartFunction

    +
    +class bumpversion.versioning.functions.ValuesFunction(values: List[str], optional_value: Optional[str] = None, first_value: Optional[str] = None)[source]#
    +

    Bases: bumpversion.versioning.functions.PartFunction

    This is a class that provides a values list based function for version parts.

    It is initialized with a list of values and iterates through them when bumping the part.

    @@ -336,8 +360,8 @@

    API#

    you get a ValueError exception.

    Initialization

    -
    -bump(value: str) → str[source]#
    +
    +bump(value: str) → str[source]#

    Return the item after value in the list.

    @@ -352,23 +376,23 @@

    API#

    PartFunction

    PartFunction

    Base class for a version part function.

    NumericFunction

    IndependentFunction

    This is a class that provides an independent function for version parts.

    NumericFunction

    This is a class that provides a numeric function for version parts.

    ValuesFunction

    ValuesFunction

    This is a class that provides a values list based function for version parts.
    + + + + + + + + + + + + + + +

    VersionComponent

    Represent part of a version number.

    VersionComponentConfig

    Configuration of a version component.

    VersionSpec

    The specification of a version’s components and their relationships.

    Version

    The specification of a version and its parts.

    +
     +

    +
    +

    API#

    +
    +
    +class bumpversion.versioning.models.VersionComponent(values: Optional[list] = None, optional_value: Optional[str] = None, first_value: Union[str, int, None] = None, independent: bool = False, source: Optional[str] = None, value: Union[str, int, None] = None)[source]#
    +

    Represent part of a version number.

    +

    Determines the PartFunction that rules how the part behaves when increased or reset +based on the configuration given.

    +

    Initialization

    +
    +
    +property value: str#
    +

    Return the value of the part.

    +
    + +
    +
    +copy() → bumpversion.versioning.models.VersionComponent[source]#
    +

    Return a copy of the part.

    +
    + +
    +
    +bump() → bumpversion.versioning.models.VersionComponent[source]#
    +

    Return a part with bumped value.

    +
    + +
    +
    +null() → bumpversion.versioning.models.VersionComponent[source]#
    +

    Return a part with first value.

    +
    + +
    +
    +property is_optional: bool#
    +

    Is the part optional?

    +
    + +
    +
    +property is_independent: bool#
    +

    Is the part independent of the other parts?

    +
    + +
    +
    +__format__(format_spec: str) → str[source]#
    +
    + +
    +
    +__repr__() → str[source]#
    +
    + +
    +
    +__eq__(other: Any) → bool[source]#
    +
    + +
    + +
    +
    +class bumpversion.versioning.models.VersionComponentConfig(**data: Any)[source]#
    +

    Bases: pydantic.BaseModel

    +

    Configuration of a version component.

    +

    This is used to read in the configuration from the bumpversion config file.

    +

    Initialization

    +

    Create a new model by parsing and validating input data from keyword arguments.

    +

    Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

    +

    __init__ uses __pydantic_self__ instead of the more common self for the first arg to +allow self as a field name.

    +
    +
    +values: Optional[list]#
    +

    None

    +
    + +
    +
    +optional_value: Optional[str]#
    +

    None

    +
    + +
    +
    +first_value: Union[str, int, None]#
    +

    None

    +
    + +
    +
    +independent: bool#
    +

    False

    +
    + +
    +
    +depends_on: Optional[str]#
    +

    None

    +
    + +
    +
    +create_component(value: Union[str, int, None] = None) → bumpversion.versioning.models.VersionComponent[source]#
    +

    Generate a version component from the configuration.

    +
    + +
    + +
    +
    +class bumpversion.versioning.models.VersionSpec(components: Dict[str, bumpversion.versioning.models.VersionComponentConfig], order: Optional[List[str]] = None)[source]#
    +

    The specification of a version’s components and their relationships.

    +

    Initialization

    +
    +
    +create_version(values: Dict[str, str]) → bumpversion.versioning.models.Version[source]#
    +

    Generate a version from the given values.

    +
    + +
    +
    +get_dependents(component_name: str) → List[str][source]#
    +

    Return the parts that depend on the given part.

    +
    + +
    + +
    +
    +class bumpversion.versioning.models.Version(version_spec: bumpversion.versioning.models.VersionSpec, components: Dict[str, bumpversion.versioning.models.VersionComponent], original: Optional[str] = None)[source]#
    +

    The specification of a version and its parts.

    +

    Initialization

    +
    +
    +values() → Dict[str, str][source]#
    +

    Return the values of the parts.

    +
    + +
    +
    +__getitem__(key: str) → bumpversion.versioning.models.VersionComponent[source]#
    +
    + +
    +
    +__len__() → int[source]#
    +
    + +
    +
    +__iter__()[source]#
    +
    + +
    +
    +__repr__()[source]#
    +
    + +
    +
    +__eq__(other: Any) → bool[source]#
    +
    + +
    +
    +required_components() → List[str][source]#
    +

    Return the names of the parts that are required.

    +
    + +
    +
    +bump(component_name: str) → bumpversion.versioning.models.Version[source]#
    +

    Increase the value of the specified component, reset its dependents, and return a new Version.

    +
    + +
    + +
    +
    +
    + +
    + + + + + + + + + + + + + \ No newline at end of file diff --git a/reference/bumpversion/bumpversion.versioning.serialization.html b/reference/bumpversion/bumpversion.versioning.serialization.html new file mode 100644 index 00000000..b9a74b34 --- /dev/null +++ b/reference/bumpversion/bumpversion.versioning.serialization.html @@ -0,0 +1,438 @@ + + + + + + + + + bumpversion.versioning.serialization - Bump My Version 0.17.1 + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bump My Version 0.17.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    + +
    +
    +
    +

    bumpversion.versioning.serialization#

    +

    Functions for serializing and deserializing version objects.

    +
    +

    Module Contents#

    +
    +

    Functions#

    +
    + + + + + + + + + + + + +

    parse_version

    Parse a version string into a dictionary of the parts and values using a regular expression.

    multisort

    Sort a list of dictionaries by multiple keys.

    serialize

    Attempts to serialize a version with the given serialization format.

    +
    +
    +
    +

    Data#

    +
    + + + + + + +

    logger

    +
    +
    +
    +

    API#

    +
    +
    +bumpversion.versioning.serialization.logger#
    +

    ‘get_indented_logger(…)’

    +
    + +
    +
    +bumpversion.versioning.serialization.parse_version(version_string: str, parse_pattern: str) → Dict[str, str][source]#
    +

    Parse a version string into a dictionary of the parts and values using a regular expression.

    +

    Args: +version_string: Version string to parse +parse_pattern: The regular expression pattern to use for parsing

    +

    Returns: +A dictionary of version part labels and their values, or an empty dictionary +if the version string doesn’t match.

    +

    Raises: +BumpVersionError: If the parse_pattern is not a valid regular expression

    +
    + +
    +
    +bumpversion.versioning.serialization.multisort(xs: list, specs: tuple) → list[source]#
    +

    Sort a list of dictionaries by multiple keys.

    +

    From https://docs.python.org/3/howto/sorting.html#sort-stability-and-complex-sorts

    +

    Args: +xs: The list of dictionaries to sort +specs: A tuple of (key, reverse) pairs

    +

    Returns: +The sorted list

    +
    + +
    +
    +bumpversion.versioning.serialization.serialize(version: bumpversion.versioning.models.Version, serialize_patterns: List[str], context: MutableMapping) → str[source]#
    +

    Attempts to serialize a version with the given serialization format.

    +
      +

    • valid serialization patterns are those that are renderable with the given context

      • +

    • formats that contain all required components are preferred

      • +

    • the shortest valid serialization pattern is used

      • +

    • if two patterns are equally short, the first one is used

      • +

    • if no valid serialization pattern is found, an error is raised

      • +
    +

    Args: +version: The version to serialize +serialize_patterns: The serialization format to use, using Python’s format string syntax +context: The context to use when serializing the version

    +

    Raises: +FormattingError: if a serialization pattern

    +

    Returns: +The serialized version as a string

    +
    + +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/reference/bumpversion/bumpversion.visualize.html b/reference/bumpversion/bumpversion.visualize.html index 6a455de0..4c1297a5 100644 --- a/reference/bumpversion/bumpversion.visualize.html +++ b/reference/bumpversion/bumpversion.visualize.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/bumpversion/bumpversion.yaml_dump.html b/reference/bumpversion/bumpversion.yaml_dump.html index 3334c690..42d47130 100644 --- a/reference/bumpversion/bumpversion.yaml_dump.html +++ b/reference/bumpversion/bumpversion.yaml_dump.html @@ -3,7 +3,7 @@ - + bumpversion.yaml_dump - Bump My Version 0.17.1 @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -428,14 +434,14 @@

    API#

    - +
    Previous
    -
    bumpversion.config.files_legacy
    +
    bumpversion.versioning.serialization
     diff --git a/reference/cli.html b/reference/cli.html index 980f896c..8aca6bdb 100644 --- a/reference/cli.html +++ b/reference/cli.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/configuration.html b/reference/configuration.html index 3c18f29f..00ce77f5 100644 --- a/reference/configuration.html +++ b/reference/configuration.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/formatting-context.html b/reference/formatting-context.html index a9eb37b2..2e53e2dc 100644 --- a/reference/formatting-context.html +++ b/reference/formatting-context.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/index.html b/reference/index.html index f32f1c9e..1d10dbb8 100644 --- a/reference/index.html +++ b/reference/index.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation @@ -260,6 +266,13 @@

    Referencebumpversion.config.files_legacy

    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -270,7 +283,6 @@

    Referencebumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • diff --git a/reference/search-and-replace-config.html b/reference/search-and-replace-config.html index 326306ec..4e5cb6e3 100644 --- a/reference/search-and-replace-config.html +++ b/reference/search-and-replace-config.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/reference/version-parts.html b/reference/version-parts.html index 1b8b9bb1..61d697c2 100644 --- a/reference/version-parts.html +++ b/reference/version-parts.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/search.html b/search.html index 15ae56f1..5a2bda54 100644 --- a/search.html +++ b/search.html @@ -182,6 +182,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -192,7 +199,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -202,7 +208,7 @@ -
  • Explanation diff --git a/searchindex.js b/searchindex.js index c4e1e06b..d776d360 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "contributing", "explanation/index", "howtos/avoid-incorrect-replacements", "howtos/custom-version-formats-by-file", "howtos/index", "howtos/multiple-replacements", "index", "readme", "reference/bumpversion/bumpversion", "reference/bumpversion/bumpversion.__main__", "reference/bumpversion/bumpversion.aliases", "reference/bumpversion/bumpversion.autocast", "reference/bumpversion/bumpversion.bump", "reference/bumpversion/bumpversion.cli", "reference/bumpversion/bumpversion.config", "reference/bumpversion/bumpversion.config.create", "reference/bumpversion/bumpversion.config.files", "reference/bumpversion/bumpversion.config.files_legacy", "reference/bumpversion/bumpversion.config.models", "reference/bumpversion/bumpversion.config.utils", "reference/bumpversion/bumpversion.exceptions", "reference/bumpversion/bumpversion.files", "reference/bumpversion/bumpversion.functions", "reference/bumpversion/bumpversion.indented_logger", "reference/bumpversion/bumpversion.scm", "reference/bumpversion/bumpversion.show", "reference/bumpversion/bumpversion.ui", "reference/bumpversion/bumpversion.utils", "reference/bumpversion/bumpversion.version_part", "reference/bumpversion/bumpversion.visualize", "reference/bumpversion/bumpversion.yaml_dump", "reference/cli", "reference/configuration", "reference/formatting-context", "reference/index", "reference/search-and-replace-config", "reference/version-parts", "tutorials/index", "tutorials/semantic-versioning-example", "usage"], "filenames": ["changelog.md", "contributing.md", "explanation/index.md", "howtos/avoid-incorrect-replacements.md", "howtos/custom-version-formats-by-file.md", "howtos/index.md", "howtos/multiple-replacements.md", "index.md", "readme.md", "reference/bumpversion/bumpversion.md", "reference/bumpversion/bumpversion.__main__.md", "reference/bumpversion/bumpversion.aliases.md", "reference/bumpversion/bumpversion.autocast.md", "reference/bumpversion/bumpversion.bump.md", "reference/bumpversion/bumpversion.cli.md", "reference/bumpversion/bumpversion.config.md", "reference/bumpversion/bumpversion.config.create.md", "reference/bumpversion/bumpversion.config.files.md", "reference/bumpversion/bumpversion.config.files_legacy.md", "reference/bumpversion/bumpversion.config.models.md", "reference/bumpversion/bumpversion.config.utils.md", "reference/bumpversion/bumpversion.exceptions.md", "reference/bumpversion/bumpversion.files.md", "reference/bumpversion/bumpversion.functions.md", "reference/bumpversion/bumpversion.indented_logger.md", "reference/bumpversion/bumpversion.scm.md", "reference/bumpversion/bumpversion.show.md", "reference/bumpversion/bumpversion.ui.md", "reference/bumpversion/bumpversion.utils.md", "reference/bumpversion/bumpversion.version_part.md", "reference/bumpversion/bumpversion.visualize.md", "reference/bumpversion/bumpversion.yaml_dump.md", "reference/cli.rst", "reference/configuration.md", "reference/formatting-context.md", "reference/index.md", "reference/search-and-replace-config.md", "reference/version-parts.md", "tutorials/index.md", "tutorials/semantic-versioning-example.md", "usage.md"], "titles": ["Changelog", "Contributing to Bump My Version", "Explanation", "Avoiding incorrect replacements", "Custom version formats in different files", "How-To Guides", "Multiple replacements within the same file", "Bump My Version", "Bump My Version", "bumpversion", "bumpversion.__main__", "bumpversion.aliases", "bumpversion.autocast", "bumpversion.bump", "bumpversion.cli", "bumpversion.config", "bumpversion.config.create", "bumpversion.config.files", "bumpversion.config.files_legacy", "bumpversion.config.models", "bumpversion.config.utils", "bumpversion.exceptions", "bumpversion.files", "bumpversion.functions", "bumpversion.indented_logger", "bumpversion.scm", "bumpversion.show", "bumpversion.ui", "bumpversion.utils", "bumpversion.version_part", "bumpversion.visualize", "bumpversion.yaml_dump", "Command-line Interface", "Configuration", "Formatting context", "Reference", "Search and replace configuration", "Version parts", "Tutorials", "Semantic versioning example", "Usage"], "terms": {"compar": [0, 6, 37], "full": [0, 4, 8, 11, 39], "differ": [0, 1, 5, 6, 7, 33, 37], "bad": [0, 21], "error": [0, 1, 27, 29], "check": [0, 1, 8, 22, 30], "scm": [0, 9, 19, 28, 35], "10e5d7d": 0, "miss": [0, 21, 33, 39], "current": [0, 1, 6, 8, 13, 14, 15, 17, 18, 22, 24, 25, 26, 29, 33, 34, 36, 39, 40], "version": [0, 3, 5, 6, 9, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 25, 26, 28, 29, 30, 35, 36, 38], "within": [0, 4, 5, 7, 37], "context": [0, 1, 7, 11, 13, 14, 17, 19, 21, 22, 24, 25, 28, 29, 33, 35, 36, 40], "a5dca4c": 0, "py3": 0, "type": [0, 1, 8, 12, 21, 25, 31, 33], "annot": [0, 25, 33, 34], "c15b23b": 0, "some": [0, 37], "output": [0, 1, 8, 26, 30, 34, 40], "visual": [0, 9, 35, 38], "406f97a": 0, "8f4bedf": 0, "test": [0, 8], "import": 0, "a74342b": 0, "refactor": [0, 1, 8], "creat": [0, 1, 4, 8, 9, 15, 19, 25, 33, 35, 38], "subcommand": [0, 8, 14, 39, 40], "f529d28": 0, "also": [0, 1, 4, 8, 23, 33, 36, 40], "organ": 0, "cli": [0, 8, 9, 35], "ad": [0, 1, 8, 37, 40], "show": [0, 1, 7, 8, 9, 14, 35, 39], "bump": [0, 3, 4, 6, 9, 14, 19, 23, 29, 30, 33, 34, 35, 36, 37, 39], "0bbd814": 0, "possibl": [0, 1, 14, 33, 37], "result": [0, 14, 36, 40], "command": [0, 7, 11, 14, 15, 33, 34, 35, 40], "sampl": [0, 14, 39], "config": [0, 1, 8, 9, 13, 22, 25, 26, 28, 29, 30, 33, 35, 36, 39], "featur": [0, 1, 34], "3d0f67d": 0, "initi": [0, 11, 19, 21, 22, 23, 24, 29, 31], "implement": [0, 1, 11, 25], "document": [0, 8, 40], "4f90348": 0, "46c9c48": 0, "extra": [0, 24, 31, 33], "whitespac": 0, "when": [0, 1, 4, 8, 23, 29, 33, 34, 37, 39], "pyproject": [0, 8, 17, 33, 40], "toml": [0, 3, 4, 8, 17, 22, 36, 39, 40], "839f17f": 0, "remov": [0, 1, 8, 34, 40], "dot": [0, 26, 37], "notat": 0, "from": [0, 3, 8, 14, 16, 19, 25, 26, 28, 33, 36, 37, 39], "requir": [0, 1, 3, 4, 8, 21, 29, 33, 40], "There": [0, 1, 8, 37, 40], "i": [0, 6, 8, 11, 12, 13, 14, 15, 17, 18, 21, 22, 23, 25, 26, 28, 29, 30, 33, 34, 36, 37, 39, 40], "an": [0, 6, 8, 11, 15, 18, 24, 25, 27, 28, 29, 31, 33, 36, 37, 39, 40], "issu": [0, 1, 8], "how": [0, 7, 8, 22, 29, 33], "set": [0, 6, 13, 28, 33, 34, 36, 37], "valu": [0, 1, 6, 8, 12, 13, 14, 15, 17, 18, 19, 21, 22, 23, 24, 26, 28, 29, 31, 34, 39, 40], "tomlkit": [0, 16], "data": 0, "structur": [0, 16], "get_nested_valu": [0, 28], "set_nested_valu": [0, 28], "replac": [0, 4, 5, 7, 14, 18, 19, 22, 29, 34, 35, 39], "pre": [0, 33, 38], "commit": [0, 8, 13, 14, 19, 25, 34, 39, 40], "ci": 0, "autoupd": 0, "ee4d2f3": 0, "github": [0, 1, 4, 6, 8, 12], "com": [0, 1, 4, 8, 12], "astral": 0, "sh": [0, 3], "ruff": 0, "v0": 0, "empti": [0, 21, 33], "string": [0, 3, 8, 12, 19, 24, 28, 29, 30, 31, 33, 34, 37], "bug": [0, 8], "d9965ab": 0, "onli": [0, 3, 8, 14, 22, 23, 25, 26, 28, 33, 34, 36, 39, 40], "trigger": [0, 40], "one": [0, 1, 8, 15, 23, 26, 33, 37, 40], "fallback": 0, "option": [0, 4, 6, 7, 11, 13, 14, 18, 19, 21, 22, 23, 24, 25, 26, 28, 29, 30, 33, 39, 40], "117": 0, "add": [0, 1, 8, 19, 24, 25, 31, 33, 39], "support": [0, 1, 8, 21, 23, 33, 38], "legaci": [0, 8, 18, 33], "multilin": [0, 36], "search": [0, 1, 3, 4, 6, 7, 14, 15, 17, 19, 22, 28, 29, 34, 35, 39], "ref": 0, "98": 0, "278eae5": 0, "2e9a400": 0, "being": 0, "abl": [0, 1, 33, 39], "tag": [0, 8, 13, 14, 15, 19, 21, 25, 28, 34, 39, 40], "without": [0, 7, 8, 28, 34], "753c990": 0, "autom": [0, 1, 38], "19215f1": 0, "The": [0, 3, 6, 8, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29, 30, 33, 34, 36, 37, 39, 40], "decoupl": 0, "flag": [0, 28, 33, 36, 37], "miscast": 0, "current_vers": [0, 3, 4, 6, 8, 13, 14, 17, 18, 19, 22, 25, 28, 34, 36, 37, 39, 40], "b8ea252": 0, "us": [0, 1, 4, 6, 7, 13, 14, 15, 17, 18, 19, 22, 24, 25, 29, 33, 34, 37, 39, 40], "configur": [0, 1, 4, 6, 7, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 26, 27, 29, 30, 34, 35, 38], "format": [0, 5, 7, 8, 18, 21, 29, 33, 35, 36, 37, 40], "singl": [0, 8, 36, 40], "digit": 0, "pars": [0, 4, 8, 14, 17, 18, 19, 25, 29, 34, 37, 39, 40], "int": [0, 14, 19, 23, 24, 25, 27, 29, 30, 31], "99": 0, "regress": 0, "2bbbd74": 0, "108": 0, "case": [0, 1, 22], "line": [0, 1, 3, 7, 14, 15, 30, 33, 35, 36, 40], "start": [0, 1, 8, 23, 28, 30, 37, 39], "regex": [0, 14, 19, 28, 36, 39], "ef4823c": 0, "workflow": [0, 8, 40], "690452e": 0, "mismatch": 0, "artifact": 0, "up": [0, 1], "download": [0, 8], "3f61742": 0, "pr_number": 0, "retriev": [0, 15, 28], "85a8b48": 0, "12ba54f": 0, "d2f30a8": 0, "pr": 0, "acquisit": 0, "67ab83d": 0, "put": [0, 34], "temporari": 0, "debug": 0, "step": [0, 1], "6ac064": 0, "chang": [0, 1, 3, 4, 6, 8, 13, 14, 18, 19, 22, 25, 33, 34, 36, 37, 39, 40], "caus": 0, "run": [0, 8, 13, 17, 18, 34, 39], "23e6c18": 0, "action": 0, "d96e07a": 0, "default": [0, 1, 3, 6, 8, 15, 16, 23, 26, 28, 33, 34, 36, 37, 38, 40], "none": [0, 8, 11, 12, 13, 14, 15, 17, 18, 19, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 40], "93191f3": 0, "64": 0, "fals": [0, 13, 17, 18, 19, 22, 24, 25, 26, 29, 30, 33, 39, 40], "wa": [0, 11, 21, 34], "overrid": [0, 15, 33], "file": [0, 1, 3, 5, 7, 9, 13, 14, 15, 16, 18, 19, 20, 21, 25, 34, 35, 36], "84556f8": 0, "gh": 0, "42bab83": 0, "regard": 0, "multipl": [0, 3, 4, 5, 7, 8, 33, 36, 37], "e7a7629": 0, "method": [0, 1, 13, 17, 22, 26], "mark": 0, "dict": [0, 16, 17, 18, 19, 20, 22, 24, 25, 26, 28, 29, 31], "kei": [0, 15, 17, 18, 21, 26, 28, 29, 40], "name": [0, 4, 8, 11, 19, 25, 26, 27, 33, 34, 37], "list": [0, 1, 8, 11, 12, 13, 14, 19, 20, 22, 23, 25, 28, 29, 30, 31, 33, 36, 37, 40], "filechang": [0, 19, 20, 22], "encapsul": 0, "log": [0, 1, 22, 24, 25, 27], "provid": [0, 1, 3, 23, 24, 34, 37, 40], "indent": [0, 24, 27, 31], "4e68214": 0, "fileconfig": [0, 22], "249a999": 0, "thi": [0, 1, 3, 4, 6, 8, 11, 18, 22, 23, 24, 26, 29, 33, 36, 39, 40], "better": [0, 1, 8], "describ": [0, 1, 33], "what": [0, 1, 39], "class": [0, 21], "doe": [0, 8, 12, 21, 22, 28], "move": [0, 8], "get_search_pattern": [0, 19], "sinc": [0, 1, 33, 34, 37, 39], "specif": [0, 8, 13, 15, 29], "each": [0, 4, 24, 33, 34, 37, 39], "instanc": 0, "manag": [0, 8, 15, 25, 29, 33], "a4c90b2": 0, "ini": [0, 8, 18, 36], "stuff": 0, "files_legaci": [0, 9, 15, 35], "py": [0, 8, 12, 33], "gener": [0, 1, 6, 8, 13, 23, 24, 28, 33, 39], "upgrad": [0, 8], "121ef69": 0, "cach": [0, 19], "resolv": [0, 19, 20, 22, 26], "filemap": [0, 19], "c96e0bd": 0, "custom": [0, 5, 7, 21], "4ce17a9": 0, "logger": [0, 13, 14, 15, 17, 18, 19, 22, 24, 25, 27, 29], "improv": 0, "consol": [0, 27, 40], "d1d19e3": 0, "909396d": 0, "ar": [0, 1, 4, 8, 12, 14, 20, 21, 30, 33, 34, 36, 37, 40], "hashabl": 0, "weed": 0, "out": [0, 1], "duplic": 0, "comment": [0, 1], "89686b8": 0, "extract_regex_flag": [0, 28], "a980670": 0, "cae12dc": 0, "e218264": 0, "74": 0, "tag_nam": [0, 14, 19, 25, 39], "now": [0, 4, 34, 39], "do": [0, 4, 33, 40], "need": [0, 1, 8, 33], "match": [0, 3, 20, 22, 33, 36], "exactli": 0, "logic": [0, 36], "auto": 0, "909a53f": 0, "http": [0, 1, 8, 12, 37], "callowayproject": [0, 1, 8], "my": [0, 3, 4, 9, 14, 19, 30, 33, 34, 36, 37, 39, 40], "85": 0, "97049e0": 0, "hg": [0, 25], "return": [0, 11, 12, 13, 15, 16, 17, 18, 19, 20, 22, 23, 24, 25, 26, 28, 29, 30, 31, 37], "order": [0, 8, 29, 33], "thei": [0, 1, 29, 33, 34], "were": [0, 8, 11], "so": [0, 6, 8, 11, 24, 33, 36], "we": [0, 1, 6, 8, 21, 26, 33, 37, 39, 40], "want": [0, 1, 8, 14, 33, 34, 39, 40], "last": [0, 33, 39], "autovers": 0, "a308a35": 0, "key_path": [0, 19], "e160b40": 0, "made": [0, 22], "all": [0, 1, 4, 8, 20, 21, 25, 29, 33, 37, 40], "attribut": [0, 26], "except": [0, 9, 23, 35, 40], "filenam": [0, 3, 4, 6, 19, 36], "glob": [0, 19, 20], "hook": [0, 33], "8188a42": 0, "more": [0, 1, 8, 19, 37, 40], "inform": [0, 1, 7, 8, 14, 18, 24, 25, 26, 33], "see": [0, 1, 8, 21, 39], "4c81ad4": 0, "7109d70": 0, "e407974": 0, "re": [0, 1, 18, 19, 22], "written": 0, "avoid": [0, 5, 7, 8, 18, 31], "wrong": [0, 3, 21], "It": [0, 1, 6, 8, 23, 33, 40], "two": [0, 8, 33, 37, 40], "wai": [0, 1, 8, 22, 40], "parser": [0, 36], "maintain": [0, 1, 4, 8, 37], "old": [0, 36], "deprec": [0, 8], "8769671": 0, "dev": [0, 1, 39], "number": [0, 4, 8, 15, 21, 22, 23, 24, 29, 33, 34, 37, 38], "463082b": 0, "1eed99b": 0, "echo": [0, 27], "develop": [0, 1, 7, 37, 39], "e89599f": 0, "5ebb0d7": 0, "65": 0, "where": [0, 8, 33], "d": [0, 4, 28, 33, 34, 36, 39], "weren": 0, "t": [0, 1, 4, 8, 13, 15, 22, 33], "357b9dc": 0, "h": [0, 8], "help": [0, 1, 8, 21, 37], "fda71b0": 0, "67": 0, "drop": [0, 8, 33], "python3": 0, "compat": [0, 8, 40], "890edc8": 0, "longer": [0, 8, 33], "": [0, 1, 3, 8, 12, 14, 22, 29, 33, 36, 37, 40], "safer": 0, "fbcef03": 0, "recommend": [0, 1, 8, 33, 40], "call": [0, 11, 37], "instead": [0, 1, 3, 8, 18, 19, 22, 36, 37], "bumpvers": [0, 3, 4, 6, 7, 8, 33, 35, 36, 37, 39, 40], "9fb1a1d": 0, "e2579d6": 0, "290": 0, "292": 0, "e21fdd9": 0, "7e5d1bc": 0, "non": [0, 33, 34, 37], "0034716": 0, "59": 0, "doc": 0, "4a3d046": 0, "285": 0, "script": [0, 1, 7], "a59ced8": 0, "depend": [0, 1, 29, 31, 33, 37], "pydant": [0, 8, 19], "577aa4c": 0, "resolut": [0, 26], "inclus": 0, "exclus": [0, 33], "646af54": 0, "61": 0, "includ": [0, 1, 3, 4, 6, 8, 13, 14, 20, 34, 37, 40], "resolved_filemap": [0, 19], "properti": [0, 19, 24, 29], "exapand": 0, "files_to_modifi": [0, 19], "modifi": [0, 1, 8, 14, 19, 22, 26, 33, 40], "exclut": 0, "add_fil": [0, 19], "c1ef3b2": 0, "55": 0, "ignor": [0, 1, 33], "falsei": 0, "construct": 0, "cd71a1a": 0, "doubl": [0, 36], "backslash": [0, 36], "while": [0, 4, 33, 36, 37], "doesn": [0, 4, 22], "7856ee0": 0, "build": [0, 33, 37], "48980d7": 0, "7c38c40": 0, "284": 0, "c30bd12": 0, "282": 0, "95c89fb": 0, "281": 0, "mention": [0, 1], "python": [0, 1, 8, 12, 14, 29, 33, 34, 36, 40], "a91f690": 0, "130bbe0": 0, "reset": [0, 24, 29, 33, 37], "befor": [0, 6, 8, 22, 33, 34, 39], "4b457d0": 0, "adb7e4c": 0, "277": 0, "pygments_styl": 0, "docsrc": 0, "conf": 0, "32798a9": 0, "theme": 0, "subject": 0, "look": [0, 1, 8, 33, 36], "about": [0, 1, 25, 26], "regular": [0, 18, 33, 34, 37, 39], "express": [0, 18, 22, 33, 34, 37, 39], "449b70a": 0, "no_regex": 0, "a295a32": 0, "global": 0, "individu": [0, 1, 33], "avail": [0, 1, 8, 33, 34, 36, 40], "sub": [0, 8, 40], "abil": 0, "0210d74": 0, "treat": [0, 33, 36], "after": [0, 22, 23, 33, 34], "substitut": 0, "warn": [0, 8, 27], "cfg": [0, 8, 17, 33], "a0481b7": 0, "e0731c3": 0, "a5bd008": 0, "45c85be": 0, "can": [0, 1, 4, 8, 13, 15, 24, 33, 34, 36, 37, 39, 40], "733438b": 0, "go": [0, 4], "bye": 0, "subcomand": 0, "leav": [0, 1], "781e8d8": 0, "complet": [0, 1, 29, 40], "ani": [0, 1, 8, 11, 12, 14, 15, 17, 18, 19, 22, 24, 26, 28, 29, 31, 40], "34": 0, "531738d": 0, "276": 0, "61e6747": 0, "charliermarsh": 0, "coverag": 0, "3fe96f0": 0, "pin": 0, "d4b125e": 0, "bfe5306": 0, "declar": 0, "sourcecodemanag": [0, 25], "classvar": [0, 25], "str": [0, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31], "_test_usable_command": [0, 25], "_commit_command": [0, 25], "_all_tags_command": [0, 25], "affect": 0, "a53cddc": 0, "c62d65e": 0, "8722a0f": 0, "work": [0, 1, 8, 21, 25, 33, 40], "just": [0, 1, 8, 18, 23, 26], "like": [0, 1, 8, 18, 24, 29, 33, 36], "increment": [0, 7, 14, 26, 33], "Will": [0, 8], "new_vers": [0, 3, 4, 6, 8, 13, 14, 17, 18, 22, 25, 26, 28, 33, 34, 36, 39, 40], "versionpart": [0, 29, 40], "would": [0, 1, 3, 11, 22, 34, 37], "short_branch_nam": [0, 25, 34], "render": [0, 13, 19, 22, 28, 29, 30, 33, 34, 36, 37], "7f7e50c": 0, "branch": [0, 34], "lower": 0, "contain": [0, 3, 4, 14, 17, 20, 22, 24, 28, 36, 40], "z": [0, 39], "truncat": [0, 34], "charact": [0, 24, 30, 37], "28": 0, "3a6e3e": 0, "part": [0, 7, 13, 14, 19, 20, 21, 22, 23, 29, 30, 34, 35, 39, 40], "ee43bdb": 0, "5e6f566": 0, "f1acd35": 0, "272": 0, "275": 0, "invoc": [0, 8, 40], "9d965e5": 0, "8960d24": 0, "tomldocu": [0, 16], "unwrap": 0, "convert": [0, 8, 12, 34], "branch_nam": [0, 25, 34], "173be1a": 0, "d537274": 0, "b01fffc": 0, "specifi": [0, 8, 14, 15, 21, 23, 33, 37, 40], "9bce887": 0, "supersed": 0, "much": [0, 1], "capabl": 0, "yaml": [0, 1, 4, 26, 31, 40], "json": [0, 26, 40], "item": [0, 23, 26, 40], "displai": [0, 26], "pull": 0, "nest": [0, 28], "31ffbcf": 0, "backward": [0, 8, 40], "previou": [0, 1, 6, 8, 30, 33, 40], "forward": [0, 1], "problem": [0, 1], "click": [0, 8, 11, 14, 21], "automat": [0, 8, 12, 39], "must": [0, 1, 3, 4, 6, 33, 36, 39], "report": [0, 8, 22], "efb04e9": 0, "correct": [0, 8, 12, 30], "5476cdf": 0, "6e500c2": 0, "270": 0, "complaint": 0, "subprocess": 0, "c429c68": 0, "da7544f": 0, "underli": 0, "edg": 0, "deriv": 0, "environ": [0, 1, 8, 28, 33, 40], "variabl": [0, 8, 12, 15, 26, 33, 40], "multpl": 0, "fail": [0, 1, 33], "reproduc": [0, 1], "d78ff46": 0, "893ec03": 0, "version_part": [0, 9, 13, 14, 17, 19, 22, 26, 28, 35], "f236b7d": 0, "detect": [0, 12], "argument": [0, 8, 19, 24, 33], "base": [0, 1, 11, 12, 15, 19, 21, 23, 24, 25, 28, 29, 30, 31], "indic": [0, 33, 34, 37], "22edeac": 0, "23be62d": 0, "rais": [0, 12, 13, 15, 19, 22, 25, 26, 27, 28, 29], "1e3ebc5": 0, "valueerror": [0, 12, 23, 28], "badargumentusag": 0, "readm": [0, 1], "7780265": 0, "releas": [0, 4, 8, 33, 36, 38, 40], "01870d5": 0, "note": [0, 8], "266002f": 0, "edc444f": 0, "261": 0, "3d5c253": 0, "instal": [0, 7], "c1034eb": 0, "spec": 0, "4782745": 0, "pypi": [0, 8], "e5ed27d": 0, "d4b03d7": 0, "vagu": 0, "info": [0, 25], "4fb5158": 0, "If": [0, 1, 3, 8, 11, 12, 13, 14, 15, 17, 25, 26, 28, 30, 33, 34, 36, 37, 39, 40], "disabl": [0, 33], "packag": [0, 8, 33], "7c12072": 0, "inspect": 0, "didn": 0, "save": 0, "dist": 0, "f8f0278": 0, "path": [0, 13, 15, 16, 17, 18, 19, 22, 25, 28, 38], "restrict": 0, "hint": 0, "e1af658": 0, "8738f3f": 0, "tabl": [0, 33], "content": 0, "49858c0": 0, "migrat": 0, "setuptool": 0, "f10f8b2": 0, "d626f7d": 0, "black": 0, "psf": 0, "ac6cdd0": 0, "serial": [0, 4, 14, 17, 18, 19, 29, 34, 37, 39, 40], "c529452": 0, "get": [0, 8, 16, 23, 26, 27, 36], "8006f3e": 0, "scminfo": [0, 19, 25, 28], "setup": [0, 8, 17, 33], "e8fddc9": 0, "xml": [0, 33], "696503f": 0, "assert": [0, 25], "7afe58c": 0, "equal": [0, 23], "64b0de3": 0, "same": [0, 1, 5, 7, 22, 30, 33, 37], "exit": [0, 8, 27], "c025650": 0, "exist": [0, 1, 11, 13, 16, 17, 22, 28], "tool": [0, 1, 3, 4, 6, 8, 13, 25, 33, 36, 37, 39], "19f13b7": 0, "pat": 0, "pipelin": 0, "hopefulli": 0, "allow": [0, 8, 19, 21, 24, 33, 39, 40], "master": [0, 12], "codecov": 0, "a5009e0": 0, "metadata": 0, "0bd54dc": 0, "1b1d910": 0, "6c3b4fe": 0, "allow_dirti": [0, 14, 19, 39], "b042e31": 0, "git": [0, 1, 8, 25, 33, 34], "2a977af": 0, "quot": [0, 3], "9a55d6d": 0, "window": [0, 1], "b8abc44": 0, "cast": [0, 12], "them": [0, 1, 3, 23, 36, 37], "pathlib": [0, 13, 15, 17, 18, 19, 25], "556853b": 0, "seem": [0, 1, 29], "ddfd3bf": 0, "fbf85c2": 0, "stop": [0, 1], "find": [0, 1, 3, 8, 11, 15, 17, 33, 36], "header": [0, 33], "0aea9dc": 0, "addit": [0, 8, 14, 34, 40], "manual": 0, "verbos": [0, 8, 14, 27, 39], "81eb097": 0, "a9cac5b": 0, "increas": [0, 8, 14, 23, 24, 29, 39, 40], "close": 0, "relas": 0, "upload": 0, "thing": [0, 40], "pythonutf8": 0, "mode": [0, 8, 40], "91a73e2": 0, "org": [0, 37], "html": 0, "utf": 0, "explicit": [0, 13, 15, 17, 33], "80fe7ef": 0, "2b3b358": 0, "cfbba08": 0, "main": [0, 8, 10], "alias": [0, 9, 35], "licens": [0, 1, 7], "34a9be5": 0, "71a204b": 0, "utf8": 0, "9cb8f60": 0, "fe794dd": 0, "function": [0, 1, 8, 9, 35, 40], "88709fd": 0, "19eaeef": 0, "d339007": 0, "convers": 0, "f5d1cab": 0, "d7dec79": 0, "857835d": 0, "dispatch": 0, "input": [0, 1, 16, 19, 21], "f3b7a0f": 0, "renam": [0, 1], "tox": 0, "job": [0, 22], "a9b6db3": 0, "e0cebb3": 0, "mercuri": [0, 8, 25, 33, 34], "560999d": 0, "6ccfa7d": 0, "subclass": [0, 11], "usageerror": [0, 21], "a447651": 0, "basevc": 0, "11c5609": 0, "consist": [0, 37], "group": [0, 8, 11, 23, 33, 37], "back": [0, 33], "6d4179b": 0, "eventu": 0, "later": 0, "creation": 0, "off": 1, "thank": [1, 8], "take": 1, "time": [1, 33], "encourag": 1, "detail": [1, 8], "handl": [1, 8, 11, 18, 22], "pleas": [1, 8], "make": [1, 6, 8, 11, 19, 20, 22], "sure": [1, 11, 20], "read": [1, 8, 17], "relev": 1, "section": [1, 6, 17, 18, 33, 39], "easier": [1, 8], "u": [1, 33, 36], "smooth": 1, "experi": 1, "involv": 1, "commun": 1, "you": [1, 4, 6, 8, 14, 23, 24, 33, 34, 36, 37, 39, 40], "don": [1, 8, 33], "fine": 1, "other": [1, 8, 29, 33, 37], "easi": [1, 24], "appreci": 1, "which": [1, 23, 24, 33, 37], "veri": [1, 8], "happi": 1, "star": 1, "tweet": 1, "refer": [1, 7, 33, 34], "local": [1, 34], "meetup": 1, "tell": 1, "friend": 1, "colleagu": 1, "everyon": 1, "particip": 1, "govern": 1, "By": [1, 8, 33, 37], "expect": 1, "uphold": 1, "unaccept": 1, "behavior": [1, 33], "coreyoordt": 1, "gmail": 1, "ask": [1, 40], "assum": 1, "best": [1, 8], "might": [1, 28, 33, 34, 37], "In": [1, 3, 4, 6, 33, 37], "found": [1, 21, 23, 33], "suitabl": 1, "still": [1, 33], "clarif": 1, "write": [1, 8, 18, 22], "advis": 1, "internet": 1, "answer": 1, "feel": 1, "follow": [1, 3, 8, 11, 14, 23, 24, 34, 36, 37, 40], "open": [1, 8], "platform": 1, "nodej": 1, "npm": 1, "etc": 1, "care": 1, "soon": [1, 4], "A": [1, 8, 13, 17, 18, 19, 20, 21, 22, 24, 25, 26, 28, 29, 30, 31, 33, 34, 37], "shouldn": 1, "chase": 1, "therefor": 1, "investig": 1, "carefulli": 1, "collect": [1, 28, 31], "advanc": 1, "fix": 1, "potenti": [1, 39], "fast": 1, "latest": [1, 8, 25, 34], "determin": [1, 12, 29], "realli": 1, "side": 1, "e": [1, 4, 8, 14, 21, 23, 33, 36, 37, 40], "g": [1, 4, 8, 14, 21, 23, 37, 40], "incompat": 1, "compon": [1, 33], "To": [1, 6, 7, 33], "user": [1, 16, 21, 27, 34], "experienc": 1, "alreadi": [1, 23, 39], "solv": 1, "tracker": 1, "stack": [1, 24], "overflow": 1, "outsid": 1, "discuss": 1, "trace": 1, "traceback": 1, "o": 1, "linux": 1, "maco": 1, "x86": 1, "arm": 1, "possibli": 1, "reliabl": 1, "And": 1, "older": 1, "never": 1, "secur": 1, "relat": 1, "vulner": 1, "sensit": 1, "elsewher": 1, "public": 1, "sent": 1, "email": 1, "track": 1, "point": [1, 8, 30], "whether": [1, 29, 33], "talk": 1, "yet": 1, "label": [1, 28, 29, 30, 39], "explain": 1, "actual": [1, 33], "reproduct": 1, "someon": 1, "els": 1, "recreat": 1, "own": 1, "usual": 1, "For": [1, 8, 33, 34, 36, 37, 40], "should": [1, 8, 13, 16, 17, 18, 22, 24, 29, 33], "isol": 1, "reduc": 1, "onc": [1, 8], "accordingli": 1, "member": 1, "try": [1, 23, 33], "obviou": 1, "those": [1, 8, 14, 33, 40], "address": 1, "until": [1, 37], "left": [1, 30], "guid": [1, 7], "through": [1, 23, 33], "new": [1, 8, 13, 16, 17, 18, 19, 26, 33, 34, 36, 38, 40], "minor": [1, 4, 8, 14, 33, 34, 36, 37, 39, 40], "guidelin": 1, "understand": 1, "cover": 1, "mayb": 1, "perform": 1, "ha": [1, 4, 6, 23, 34, 37, 39], "been": 1, "idea": [1, 18, 29], "fit": [1, 30], "scope": 1, "aim": 1, "strong": 1, "convinc": 1, "merit": 1, "keep": 1, "mind": 1, "major": [1, 4, 8, 33, 34, 37, 39, 40], "our": [1, 8], "small": [1, 8], "subset": 1, "target": 1, "consid": [1, 23, 33, 37], "plugin": 1, "librari": 1, "clear": 1, "descript": [1, 33], "titl": 1, "identifi": 1, "benefit": 1, "why": 1, "most": [1, 8, 29], "mai": [1, 3, 8, 14, 23, 33, 37, 40], "could": 1, "serv": 1, "inspir": 1, "mani": 1, "altern": [1, 36], "appropri": 1, "legal": 1, "notic": 1, "agre": 1, "author": 1, "100": 1, "necessari": 1, "right": [1, 30], "under": [1, 8], "sever": [1, 6, 17], "termin": 1, "clone": 1, "repositori": [1, 34], "enter": 1, "cd": 1, "activ": 1, "virtual": 1, "m": [1, 34], "venv": 1, "env": [1, 15], "sourc": [1, 8, 11, 12, 13, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 33], "bin": 1, "pip": [1, 8], "r": [1, 36], "txt": [1, 3, 8, 33, 40], "pytest": 1, "everi": [1, 8, 34], "here": [1, 8, 33], "basic": [1, 12, 36], "process": [1, 24, 30, 33, 36, 40], "categor": 1, "exampl": [1, 4, 6, 7, 8, 11, 24, 30, 34, 36, 37, 38, 40], "cool": 1, "updat": [1, 8, 13, 16, 17, 18, 22, 33], "delet": 1, "refacto": 1, "chg": 1, "modif": 1, "taxonomi": 1, "schema": 1, "419": 1, "123": 1, "summari": 1, "cosmet": 1, "wip": 1, "reach": 1, "gen": 1, "have": [3, 4, 6, 8, 29, 33, 34, 37], "given": [3, 8, 11, 14, 25, 28, 29, 40], "myproject": [3, 4, 36], "django": [3, 26], "1": [3, 4, 8, 9, 24, 30, 33, 36, 37, 39, 40], "5": [3, 8, 40], "6": [3, 8, 40], "templat": [3, 25, 26, 33], "text": [3, 8, 36], "0": [3, 8, 9, 23, 25, 26, 27, 30, 33, 37, 39, 40], "ensur": [3, 34], "liter": [3, 34, 36], "pattern": [3, 19, 20, 22, 28, 33, 36, 37], "my_vers": 3, "2": [3, 4, 8, 24, 33, 36, 37, 39, 40], "3": [3, 8, 36, 39], "Then": 3, "even": 4, "modul": [4, 7, 10], "awar": 4, "project": [4, 8, 14, 37, 40], "your": [4, 8, 14, 33, 34, 36], "beyond": 4, "v1": [4, 24], "myorg": 4, "v2": [4, 8, 24], "howev": [4, 36], "channel": 4, "mod": 4, "12": 4, "stabl": [4, 37], "21": 4, "4": [4, 36, 37, 39], "p": [4, 33, 37, 39], "v": [4, 8, 33, 39], "patch": [4, 8, 33, 34, 37, 39], "As": 4, "direct": [4, 7], "v3": 4, "incorrect": [5, 7], "changelog": [6, 7, 33], "unreleas": [6, 33, 36], "head": [6, 33], "link": 6, "entri": [6, 33], "unnecessari": 6, "anoth": 6, "its": [6, 17, 29, 33, 37], "md": [6, 8, 33], "introduct": 7, "overview": 7, "futur": [7, 33], "usag": 7, "contribut": 7, "tutori": 7, "semant": [7, 37, 38], "interfac": [7, 8, 14, 27, 35], "explan": 7, "index": [7, 8, 26], "page": 7, "bump2vers": 8, "fork": 8, "excel": 8, "goal": 8, "rich": 8, "valid": [8, 14, 19, 36, 40], "code": [8, 25, 33], "softwar": [8, 33], "simplifi": [8, 39], "highli": 8, "happili": 8, "program": 8, "languag": 8, "8": [8, 33], "pypy3": 8, "switch": [8, 39], "both": [8, 33, 36, 37], "truli": 8, "alwai": [8, 36, 39], "ui": [8, 9, 35], "throughout": [8, 40], "interchang": [8, 40], "oper": [8, 13, 40], "On": [8, 40], "complex": [8, 40], "multi": [8, 40], "split": [8, 40], "remain": [8, 40], "discourag": [8, 40], "defin": [8, 34, 37], "These": [8, 33, 34], "rewrit": [8, 14, 40], "9": [8, 33, 37, 39, 40], "four": [8, 33], "place": [8, 33, 37], "preced": [8, 33, 37], "bumpversion_config_fil": [8, 33], "due": 8, "style": 8, "system": [8, 25, 33], "greater": [8, 33], "flexibl": [8, 33], "abov": [8, 37], "addition": 8, "dry": [8, 13, 17, 18], "n": [8, 25, 36], "touch": 8, "pretend": 8, "similar": 8, "print": [8, 14], "stderr": 8, "than": [8, 40], "machin": 8, "readabl": 8, "stdout": [8, 16], "consumpt": 8, "18": 8, "19": 8, "sai": 8, "flow": 8, "know": [8, 37], "appli": 8, "standard": 8, "bash": 8, "becom": [8, 34], "contributor": 8, "graph": 8, "happen": 8, "welcom": 8, "well": 8, "aspect": 8, "intend": 8, "versatil": 8, "mit": 8, "top": [9, 30], "level": [9, 24], "util": [9, 11, 15, 25, 27, 35], "model": [9, 15, 17, 20, 22, 29, 35], "yaml_dump": [9, 35], "autocast": [9, 35], "indented_logg": [9, 27, 35], "__main__": [9, 35], "__version__": 9, "17": [9, 36], "entrypoint": 10, "aliasedgroup": 11, "accept": 11, "prefix": [11, 34], "arg": [11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 22, 24, 25, 26, 28, 29, 30, 33, 40], "kwarg": [11, 24, 28, 31], "rich_click": 11, "rich_group": 11, "richgroup": 11, "push": [11, 33], "pu": 11, "alia": 11, "long": 11, "uniqu": [11, 33], "get_command": 11, "ctx": [11, 13, 14, 21], "cmd_name": 11, "object": [11, 24, 26, 29, 34], "resolve_command": 11, "tupl": [11, 16, 19, 24, 28, 29, 31], "true": [12, 13, 16, 17, 18, 22, 24, 25, 26, 30, 33, 36, 37], "cgreer": 12, "cgautocast": 12, "blob": 12, "boolifi": 12, "boolean": [12, 33, 34], "noneifi": 12, "listifi": 12, "represent": [12, 29, 31], "homogen": 12, "autocast_valu": 12, "guess": 12, "bool": [12, 13, 14, 16, 17, 18, 19, 22, 23, 24, 25, 26, 29, 30, 31], "element": [12, 28, 37], "via": [12, 15, 33], "first": [12, 19, 23, 29, 30, 33], "success": 12, "repres": [12, 21, 28, 29, 33, 34], "typeerror": 12, "var": [12, 33, 34], "get_next_vers": 13, "next": [13, 22, 30, 37, 39], "do_bump": 13, "commit_and_tag": 13, "get_indented_logg": [13, 14, 15, 17, 18, 19, 22, 25, 27, 29], "configurationerror": [13, 15, 21], "config_fil": [13, 14, 15, 17, 18], "dry_run": [13, 14, 17, 18, 22, 25], "configured_fil": 13, "configuredfil": [13, 22], "chainmap": [13, 28], "messag": [13, 14, 19, 21, 24, 25, 27, 28, 34, 39], "sample_config": 14, "show_bump": 14, "core": 14, "no_configured_fil": 14, "ignore_missing_vers": [14, 19, 39], "sign_tag": [14, 19, 39], "tag_messag": [14, 19, 39], "commit_arg": [14, 19, 39], "show_list": 14, "format_": [14, 26], "prompt": [14, 16, 39], "destin": [14, 16, 39], "ascii": 14, "get_configur": 15, "check_current_vers": 15, "union": [15, 17, 18, 19, 23, 25, 29, 31], "otherwis": [15, 23, 25, 36], "attempt": [15, 29, 36], "dictionari": [15, 17, 18, 28], "create_configur": 16, "get_defaults_from_dest": 16, "find_config_fil": 17, "read_config_fil": 17, "read_toml_fil": 17, "update_config_fil": 17, "config_file_search_ord": 17, "explicit_fil": 17, "pass": [17, 24, 33], "explicitli": [17, 18, 33], "file_path": [17, 18, 22], "mutablemap": [17, 19, 22, 24, 25, 29], "read_ini_fil": 18, "update_ini_config_fil": 18, "unintent": 18, "versionpartconfig": [19, 20, 22, 29], "basemodel": 19, "keyword": [19, 24, 33], "validationerror": 19, "pydantic_cor": 19, "cannot": [19, 26, 39], "form": 19, "__init__": [19, 33], "__pydantic_self__": 19, "common": 19, "self": [19, 21], "field": [19, 33, 36], "optional_valu": [19, 23, 37, 39], "first_valu": [19, 23, 37], "independ": [19, 23, 29], "__hash__": 19, "hash": [19, 34], "compil": [19, 22, 23, 36], "raw": [19, 22], "_case_sensit": 19, "_env_prefix": 19, "_env_fil": 19, "pydantic_set": 19, "dotenvtyp": 19, "env_file_sentinel": 19, "_env_file_encod": 19, "_env_nested_delimit": 19, "_secrets_dir": 19, "baseset": 19, "scm_info": [19, 28], "included_path": 19, "excluded_path": 19, "model_config": 19, "settingsconfigdict": 19, "_resolved_filemap": 19, "_resolve_filemap": 19, "map": [19, 26], "expand": 19, "version_config": [19, 22], "versionconfig": [19, 22, 29], "helper": 20, "get_all_file_config": 20, "get_all_part_config": 20, "resolve_glob_fil": 20, "config_dict": 20, "file_cfg": 20, "accord": [20, 22], "bumpversionerror": 21, "accur": 21, "signatur": [21, 24], "formattingerror": [21, 29], "unabl": 21, "missingvalueerror": [21, 29], "dirtyworkingdirectoryerror": 21, "directori": [21, 25, 33], "dirti": [21, 25, 33, 34], "signedtagserror": [21, 25], "vc": [21, 25], "sign": [21, 25, 33], "versionnotfounderror": [21, 22], "invalidversionparterror": 21, "bugfix": 21, "badinputerror": [21, 26], "fileupdat": 22, "datafileupdat": 22, "contains_pattern": 22, "log_chang": 22, "resolve_file_config": 22, "modify_fil": 22, "file_content_befor": 22, "file_content_aft": 22, "file_chang": 22, "get_file_cont": 22, "filenotfounderror": 22, "write_file_cont": 22, "_contains_change_pattern": 22, "search_express": 22, "raw_search_express": 22, "origin": [22, 29], "isn": 22, "present": [22, 33], "fact": 22, "make_file_chang": 22, "__str__": [22, 25], "__repr__": [22, 25, 29], "update_fil": 22, "version_part_config": 22, "_update_toml_fil": 22, "search_for": 22, "raw_search_pattern": 22, "replace_with": 22, "partfunct": [23, 29], "numericfunct": 23, "numer": [23, 33, 37], "valuesfunct": 23, "abstract": [23, 25], "simpli": 23, "sequenc": [23, 26, 37], "integ": [23, 37], "alphanumer": [23, 34], "alter": [23, 33, 39], "r3": 23, "r4": 23, "001": 23, "first_numer": 23, "iter": [23, 33], "maximum": [23, 39], "adapt": 24, "begin": [24, 33], "indentedloggeradapt": [24, 27], "current_ind": 24, "contextvar": 24, "depth": 24, "indent_char": 24, "loggeradapt": 24, "paramet": 24, "zero": 24, "contextu": 24, "constructor": 24, "desir": 24, "effect": 24, "shown": 24, "somelogg": 24, "p1": 24, "p2": 24, "amount": [24, 30], "dedent": 24, "decreas": 24, "indent_str": 24, "msg": [24, 27], "control": 25, "state": 25, "get_scm_info": 25, "commit_sha": [25, 34], "distance_to_latest_tag": [25, 34, 39], "classmethod": 25, "extra_arg": 25, "is_us": 25, "usabl": 25, "assert_nondirti": 25, "latest_tag_info": 25, "parse_pattern": 25, "add_path": 25, "get_all_tag": 25, "get_version_from_tag": 25, "commit_to_scm": 25, "tag_in_scm": 25, "rev": 25, "dir": 25, "f": 25, "lightweight": [25, 33], "root": 25, "logfil": 25, "clean": 25, "output_default": 26, "output_yaml": 26, "output_json": 26, "resolve_nam": 26, "attr": 26, "obj": 26, "log_list": 26, "do_show": 26, "outputt": 26, "err_on_miss": 26, "copi": [26, 29], "lookup": 26, "access": 26, "mykei": 26, "noqa": 26, "dar401": 26, "setup_log": 27, "print_info": 27, "print_error": 27, "print_warn": 27, "getlogg": 27, "extract": [28, 39], "recursive_sort_dict": 28, "sort": 28, "recurs": 28, "key_val_str": 28, "comma": 28, "delimit": 28, "prefixed_environ": 28, "wrap": 28, "labels_for_format": 28, "serialize_format": [28, 29], "base_context": 28, "get_context": 28, "get_overrid": 28, "overridden": 28, "regex_pattern": 28, "input_valu": 28, "separ": [28, 37], "period": 28, "keyerror": 28, "intern": [29, 33], "hold": 29, "rule": 29, "behav": 29, "null": 29, "is_opt": 29, "is_independ": 29, "__format__": 29, "format_spec": 29, "__eq__": 29, "__getitem__": 29, "__len__": 29, "__iter__": 29, "part_nam": 29, "part_config": 29, "good": [29, 39], "becaus": [29, 37, 39], "version_str": [29, 30], "_serial": 29, "raise_if_incomplet": 29, "syntax": [29, 33, 36], "incomplet": 29, "serializ": 29, "_choose_serialize_format": 29, "border": 30, "definit": 30, "lead_str": 30, "space": 30, "connection_str": 30, "connect": 30, "labeled_lin": 30, "pad": 30, "filter_version_part": 30, "box_char": 30, "corner_bottom_right": 30, "corner_top_right": 30, "corner_top_left": 30, "corner_bottom_left": 30, "divider_left": 30, "divider_up": 30, "divider_down": 30, "divider_right": 30, "pipe": 30, "cross": 30, "blank": 30, "light": 30, "draw": 30, "length": 30, "has_next": 30, "has_previ": 30, "bottom": 30, "fit_length": 30, "lead": 30, "trail": 30, "against": 30, "box_styl": 30, "simpl": [31, 36], "dumper": 31, "yamldump": 31, "registri": 31, "dump": 31, "buffer": 31, "format_str": 31, "format_int": 31, "format_float": 31, "float": 31, "format_bool": 31, "format_dict": 31, "format_sequ": 31, "format_non": 31, "format_d": 31, "date": [31, 36], "format_datetim": 31, "dumperfunc": 31, "userdict": 31, "add_dump": 31, "data_typ": 31, "val": 31, "_": 31, "datetim": [31, 34], "three": [33, 37], "respectfulli": 33, "No": 33, "anyth": 33, "uncommit": 33, "bumpversion_allow_dirti": 33, "abort": 33, "protect": 33, "unvers": 33, "overwrit": 33, "unsav": 33, "bumpversion_commit": 33, "verifi": 33, "bumpversion_messag": 33, "bumpversion_commit_arg": 33, "bumpversion_tag": 33, "forget": 33, "done": 33, "bumpversion_sign_tag": 33, "bumpversion_tag_nam": 33, "bumpversion_tag_messag": 33, "ye": 33, "bumpversion_current_vers": 33, "bumpversion_pars": 33, "produc": 33, "belong": 33, "arrai": 33, "bumpversion_seri": 33, "choos": 33, "bumpversion_search": 33, "span": 33, "remotest": 33, "mean": 33, "occurr": 33, "bumpversion_replac": 33, "bumpversion_ignore_missing_vers": 33, "partnam": 33, "deviat": 33, "final": [33, 39], "Its": 33, "alpha": [33, 37], "beta": [33, 37], "gamma": 33, "newli": 33, "Their": 33, "directli": 33, "wildcard": 33, "pom": 33, "certain": 33, "append": 33, "between": 33, "paren": 33, "special": [33, 39], "coolapp": 33, "twice": 33, "mutual": 33, "octothorp": 34, "semicolon": 34, "zone": 34, "utcnow": 34, "utc": 34, "guidanc": 34, "colon": 34, "y": 34, "2023": [34, 36], "04": 34, "20": 34, "pend": 34, "lowercas": 34, "long_branch": 34, "featuremylongbranchn": 34, "current_": 34, "current_major": 34, "current_minor": 34, "current_patch": 34, "new_": 34, "new_major": 34, "new_minor": 34, "new_patch": 34, "runtim": 34, "execut": 34, "export": [34, 40], "combin": 36, "escap": 36, "unescap": 36, "enclos": 36, "curli": 36, "brace": 36, "nversion": 36, "unless": 36, "07": 36, "l": 36, "variou": 37, "typic": 37, "recent": 37, "omit": 37, "second": 37, "finish": 37, "release_nam": 37, "witti": 37, "warthog": 37, "ridicul": 37, "rat": 37, "marvel": 37, "manti": 37, "stage": 37, "x": [37, 39], "pre_label": 37, "pre_n": [37, 38], "again": 37, "devopedia": 37, "semver": 37, "calver": 37, "cat": 39, "extend": 39, "dash": 39, "seper": 39, "pre_l": 39, "za": 39, "rc": 39, "dev0": 39, "invalid": 39, "among": 39, "final1": 39, "rc0": 39, "dev1": 39, "rc1": 39, "decid": 39, "candid": 39, "simplest": 40, "_version": 40, "entir": 40, "request": 40, "pprint": 40, "enabl": 40, "ident": 40, "One": 40, "bumpversion_new_vers": 40}, "objects": {"": [[9, 0, 0, "-", "bumpversion"]], "bumpversion": [[10, 0, 0, "-", "__main__"], [9, 1, 1, "", "__version__"], [11, 0, 0, "-", "aliases"], [12, 0, 0, "-", "autocast"], [13, 0, 0, "-", "bump"], [14, 0, 0, "-", "cli"], [15, 0, 0, "-", "config"], [21, 0, 0, "-", "exceptions"], [22, 0, 0, "-", "files"], [23, 0, 0, "-", "functions"], [24, 0, 0, "-", "indented_logger"], [25, 0, 0, "-", "scm"], [26, 0, 0, "-", "show"], [27, 0, 0, "-", "ui"], [28, 0, 0, "-", "utils"], [29, 0, 0, "-", "version_part"], [30, 0, 0, "-", "visualize"], [31, 0, 0, "-", "yaml_dump"]], "bumpversion.aliases": [[11, 2, 1, "", "AliasedGroup"]], "bumpversion.aliases.AliasedGroup": [[11, 3, 1, "", "get_command"], [11, 3, 1, "", "resolve_command"]], "bumpversion.autocast": [[12, 4, 1, "", "autocast_value"], [12, 4, 1, "", "boolify"], [12, 4, 1, "", "listify"], [12, 4, 1, "", "noneify"]], "bumpversion.bump": [[13, 4, 1, "", "commit_and_tag"], [13, 4, 1, "", "do_bump"], [13, 4, 1, "", "get_next_version"], [13, 1, 1, "", "logger"]], "bumpversion.cli": [[14, 4, 1, "", "bump"], [14, 4, 1, "", "cli"], [14, 1, 1, "", "logger"], [14, 4, 1, "", "replace"], [14, 4, 1, "", "sample_config"], [14, 4, 1, "", "show"], [14, 4, 1, "", "show_bump"]], "bumpversion.config": [[15, 1, 1, "", "DEFAULTS"], [15, 4, 1, "", "check_current_version"], [16, 0, 0, "-", "create"], [17, 0, 0, "-", "files"], [18, 0, 0, "-", "files_legacy"], [15, 4, 1, "", "get_configuration"], [15, 1, 1, "", "logger"], [19, 0, 0, "-", "models"], [20, 0, 0, "-", "utils"]], "bumpversion.config.create": [[16, 4, 1, "", "create_configuration"], [16, 4, 1, "", "get_defaults_from_dest"]], "bumpversion.config.files": [[17, 1, 1, "", "CONFIG_FILE_SEARCH_ORDER"], [17, 4, 1, "", "find_config_file"], [17, 1, 1, "", "logger"], [17, 4, 1, "", "read_config_file"], [17, 4, 1, "", "read_toml_file"], [17, 4, 1, "", "update_config_file"]], "bumpversion.config.files_legacy": [[18, 1, 1, "", "logger"], [18, 4, 1, "", "read_ini_file"], [18, 4, 1, "", "update_ini_config_file"]], "bumpversion.config.models": [[19, 2, 1, "", "Config"], [19, 2, 1, "", "FileChange"], [19, 2, 1, "", "VersionPartConfig"], [19, 1, 1, "", "logger"]], "bumpversion.config.models.Config": [[19, 3, 1, "", "_resolve_filemap"], [19, 5, 1, "", "_resolved_filemap"], [19, 3, 1, "", "add_files"], [19, 5, 1, "", "allow_dirty"], [19, 5, 1, "", "commit"], [19, 5, 1, "", "commit_args"], [19, 5, 1, "", "current_version"], [19, 5, 1, "", "excluded_paths"], [19, 5, 1, "", "files"], [19, 6, 1, "", "files_to_modify"], [19, 5, 1, "", "ignore_missing_version"], [19, 5, 1, "", "included_paths"], [19, 5, 1, "", "message"], [19, 5, 1, "", "model_config"], [19, 5, 1, "", "parse"], [19, 5, 1, "", "parts"], [19, 5, 1, "", "regex"], [19, 5, 1, "", "replace"], [19, 6, 1, "", "resolved_filemap"], [19, 5, 1, "", "scm_info"], [19, 5, 1, "", "search"], [19, 5, 1, "", "serialize"], [19, 5, 1, "", "sign_tags"], [19, 5, 1, "", "tag"], [19, 5, 1, "", "tag_message"], [19, 5, 1, "", "tag_name"], [19, 6, 1, "", "version_config"]], "bumpversion.config.models.FileChange": [[19, 3, 1, "", "__hash__"], [19, 5, 1, "", "filename"], [19, 3, 1, "", "get_search_pattern"], [19, 5, 1, "", "glob"], [19, 5, 1, "", "ignore_missing_version"], [19, 5, 1, "", "key_path"], [19, 5, 1, "", "parse"], [19, 5, 1, "", "regex"], [19, 5, 1, "", "replace"], [19, 5, 1, "", "search"], [19, 5, 1, "", "serialize"]], "bumpversion.config.models.VersionPartConfig": [[19, 5, 1, "", "first_value"], [19, 5, 1, "", "independent"], [19, 5, 1, "", "optional_value"], [19, 5, 1, "", "values"]], "bumpversion.config.utils": [[20, 4, 1, "", "get_all_file_configs"], [20, 4, 1, "", "get_all_part_configs"], [20, 4, 1, "", "resolve_glob_files"]], "bumpversion.exceptions": [[21, 7, 1, "", "BadInputError"], [21, 7, 1, "", "BumpVersionError"], [21, 7, 1, "", "ConfigurationError"], [21, 7, 1, "", "DirtyWorkingDirectoryError"], [21, 7, 1, "", "FormattingError"], [21, 7, 1, "", "InvalidVersionPartError"], [21, 7, 1, "", "MissingValueError"], [21, 7, 1, "", "SignedTagsError"], [21, 7, 1, "", "VersionNotFoundError"]], "bumpversion.files": [[22, 2, 1, "", "ConfiguredFile"], [22, 2, 1, "", "DataFileUpdater"], [22, 2, 1, "", "FileUpdater"], [22, 4, 1, "", "contains_pattern"], [22, 4, 1, "", "log_changes"], [22, 1, 1, "", "logger"], [22, 4, 1, "", "modify_files"], [22, 4, 1, "", "resolve_file_config"]], "bumpversion.files.ConfiguredFile": [[22, 3, 1, "", "__repr__"], [22, 3, 1, "", "__str__"], [22, 3, 1, "", "_contains_change_pattern"], [22, 3, 1, "", "get_file_contents"], [22, 3, 1, "", "make_file_change"], [22, 3, 1, "", "write_file_contents"]], "bumpversion.files.DataFileUpdater": [[22, 3, 1, "", "_update_toml_file"], [22, 3, 1, "", "update_file"]], "bumpversion.files.FileUpdater": [[22, 3, 1, "", "update_file"]], "bumpversion.functions": [[23, 2, 1, "", "NumericFunction"], [23, 2, 1, "", "PartFunction"], [23, 2, 1, "", "ValuesFunction"]], "bumpversion.functions.NumericFunction": [[23, 5, 1, "", "FIRST_NUMERIC"], [23, 3, 1, "", "bump"]], "bumpversion.functions.PartFunction": [[23, 3, 1, "", "bump"], [23, 5, 1, "", "first_value"], [23, 5, 1, "", "independent"], [23, 5, 1, "", "optional_value"]], "bumpversion.functions.ValuesFunction": [[23, 3, 1, "", "bump"]], "bumpversion.indented_logger": [[24, 1, 1, "", "CURRENT_INDENT"], [24, 2, 1, "", "IndentedLoggerAdapter"]], "bumpversion.indented_logger.IndentedLoggerAdapter": [[24, 6, 1, "", "current_indent"], [24, 3, 1, "", "dedent"], [24, 3, 1, "", "indent"], [24, 6, 1, "", "indent_str"], [24, 3, 1, "", "process"], [24, 3, 1, "", "reset"]], "bumpversion.scm": [[25, 2, 1, "", "Git"], [25, 2, 1, "", "Mercurial"], [25, 2, 1, "", "SCMInfo"], [25, 2, 1, "", "SourceCodeManager"], [25, 4, 1, "", "get_scm_info"], [25, 1, 1, "", "logger"]], "bumpversion.scm.Git": [[25, 5, 1, "", "_ALL_TAGS_COMMAND"], [25, 5, 1, "", "_COMMIT_COMMAND"], [25, 5, 1, "", "_TEST_USABLE_COMMAND"], [25, 3, 1, "", "add_path"], [25, 3, 1, "", "assert_nondirty"], [25, 3, 1, "", "latest_tag_info"], [25, 3, 1, "", "tag"]], "bumpversion.scm.Mercurial": [[25, 5, 1, "", "_ALL_TAGS_COMMAND"], [25, 5, 1, "", "_COMMIT_COMMAND"], [25, 5, 1, "", "_TEST_USABLE_COMMAND"], [25, 3, 1, "", "add_path"], [25, 3, 1, "", "assert_nondirty"], [25, 3, 1, "", "latest_tag_info"], [25, 3, 1, "", "tag"]], "bumpversion.scm.SCMInfo": [[25, 3, 1, "", "__repr__"], [25, 3, 1, "", "__str__"], [25, 5, 1, "", "branch_name"], [25, 5, 1, "", "commit_sha"], [25, 5, 1, "", "current_version"], [25, 5, 1, "", "dirty"], [25, 5, 1, "", "distance_to_latest_tag"], [25, 5, 1, "", "short_branch_name"], [25, 5, 1, "", "tool"]], "bumpversion.scm.SourceCodeManager": [[25, 5, 1, "", "_ALL_TAGS_COMMAND"], [25, 5, 1, "", "_COMMIT_COMMAND"], [25, 5, 1, "", "_TEST_USABLE_COMMAND"], [25, 3, 1, "", "__repr__"], [25, 3, 1, "", "__str__"], [25, 3, 1, "", "add_path"], [25, 3, 1, "", "assert_nondirty"], [25, 3, 1, "", "commit"], [25, 3, 1, "", "commit_to_scm"], [25, 3, 1, "", "get_all_tags"], [25, 3, 1, "", "get_version_from_tag"], [25, 3, 1, "", "is_usable"], [25, 3, 1, "", "latest_tag_info"], [25, 3, 1, "", "tag"], [25, 3, 1, "", "tag_in_scm"]], "bumpversion.show": [[26, 1, 1, "", "OUTPUTTERS"], [26, 4, 1, "", "do_show"], [26, 4, 1, "", "log_list"], [26, 4, 1, "", "output_default"], [26, 4, 1, "", "output_json"], [26, 4, 1, "", "output_yaml"], [26, 4, 1, "", "resolve_name"]], "bumpversion.ui": [[27, 1, 1, "", "VERBOSITY"], [27, 4, 1, "", "get_indented_logger"], [27, 1, 1, "", "logger"], [27, 4, 1, "", "print_error"], [27, 4, 1, "", "print_info"], [27, 4, 1, "", "print_warning"], [27, 4, 1, "", "setup_logging"]], "bumpversion.utils": [[28, 4, 1, "", "base_context"], [28, 4, 1, "", "extract_regex_flags"], [28, 4, 1, "", "get_context"], [28, 4, 1, "", "get_nested_value"], [28, 4, 1, "", "get_overrides"], [28, 4, 1, "", "key_val_string"], [28, 4, 1, "", "labels_for_format"], [28, 4, 1, "", "prefixed_environ"], [28, 4, 1, "", "recursive_sort_dict"], [28, 4, 1, "", "set_nested_value"]], "bumpversion.version_part": [[29, 2, 1, "", "Version"], [29, 2, 1, "", "VersionConfig"], [29, 2, 1, "", "VersionPart"], [29, 1, 1, "", "logger"]], "bumpversion.version_part.Version": [[29, 3, 1, "", "__eq__"], [29, 3, 1, "", "__getitem__"], [29, 3, 1, "", "__iter__"], [29, 3, 1, "", "__len__"], [29, 3, 1, "", "__repr__"], [29, 3, 1, "", "bump"]], "bumpversion.version_part.VersionConfig": [[29, 3, 1, "", "__eq__"], [29, 3, 1, "", "__repr__"], [29, 3, 1, "", "_choose_serialize_format"], [29, 3, 1, "", "_serialize"], [29, 6, 1, "", "order"], [29, 3, 1, "", "parse"], [29, 3, 1, "", "serialize"]], "bumpversion.version_part.VersionPart": [[29, 3, 1, "", "__eq__"], [29, 3, 1, "", "__format__"], [29, 3, 1, "", "__repr__"], [29, 3, 1, "", "bump"], [29, 3, 1, "", "copy"], [29, 6, 1, "", "is_independent"], [29, 6, 1, "", "is_optional"], [29, 3, 1, "", "null"], [29, 6, 1, "", "value"]], "bumpversion.visualize": [[30, 1, 1, "", "BOX_CHARS"], [30, 2, 1, "", "Border"], [30, 4, 1, "", "connection_str"], [30, 4, 1, "", "filter_version_parts"], [30, 4, 1, "", "labeled_line"], [30, 4, 1, "", "lead_string"], [30, 4, 1, "", "visualize"]], "bumpversion.visualize.Border": [[30, 5, 1, "", "corner_bottom_left"], [30, 5, 1, "", "corner_bottom_right"], [30, 5, 1, "", "corner_top_left"], [30, 5, 1, "", "corner_top_right"], [30, 5, 1, "", "cross"], [30, 5, 1, "", "divider_down"], [30, 5, 1, "", "divider_left"], [30, 5, 1, "", "divider_right"], [30, 5, 1, "", "divider_up"], [30, 5, 1, "", "line"], [30, 5, 1, "", "pipe"]], "bumpversion.yaml_dump": [[31, 1, 1, "", "DumperFunc"], [31, 1, 1, "", "INDENT"], [31, 2, 1, "", "YAMLDumpers"], [31, 1, 1, "", "YAML_DUMPERS"], [31, 4, 1, "", "dump"], [31, 4, 1, "", "format_bool"], [31, 4, 1, "", "format_date"], [31, 4, 1, "", "format_datetime"], [31, 4, 1, "", "format_dict"], [31, 4, 1, "", "format_float"], [31, 4, 1, "", "format_int"], [31, 4, 1, "", "format_none"], [31, 4, 1, "", "format_sequence"], [31, 4, 1, "", "format_str"]], "bumpversion.yaml_dump.YAMLDumpers": [[31, 3, 1, "", "add_dumper"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:method", "4": "py:function", "5": "py:attribute", "6": "py:property", "7": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"], "5": ["py", "attribute", "Python attribute"], "6": ["py", "property", "Python property"], "7": ["py", "exception", "Python exception"]}, "titleterms": {"changelog": [0, 8], "0": 0, "17": 0, "1": 0, "2024": 0, "01": 0, "25": 0, "fix": 0, "22": 0, "new": [0, 39], "updat": 0, "16": 0, "2": 0, "13": 0, "other": 0, "06": 0, "05": 0, "15": 0, "4": 0, "2023": 0, "12": 0, "29": 0, "3": 0, "18": 0, "14": 0, "11": 0, "04": 0, "09": 0, "26": 0, "10": 0, "9": 0, "08": 0, "07": 0, "03": 0, "8": 0, "7": 0, "6": 0, "23": 0, "5": 0, "20": 0, "24": 0, "contribut": [1, 8], "bump": [1, 7, 8, 13, 40], "my": [1, 7, 8], "version": [1, 4, 7, 8, 33, 34, 37, 39, 40], "tabl": [1, 7], "content": [1, 7, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31], "code": [1, 34], "conduct": 1, "i": 1, "have": 1, "question": 1, "report": 1, "bug": 1, "befor": 1, "submit": 1, "how": [1, 5], "do": 1, "good": 1, "suggest": 1, "enhanc": 1, "an": 1, "your": 1, "first": [1, 37], "setup": 1, "run": 1, "test": 1, "instal": [1, 8], "pre": [1, 39], "commit": [1, 33], "hook": 1, "improv": 1, "The": 1, "document": 1, "styleguid": 1, "style": [1, 33], "messag": [1, 33], "join": 1, "project": 1, "team": 1, "attribut": 1, "explan": 2, "avoid": 3, "incorrect": 3, "replac": [3, 6, 33, 36, 40], "custom": 4, "format": [4, 34], "differ": 4, "file": [4, 6, 8, 17, 22, 33, 40], "To": 5, "guid": 5, "multipl": 6, "within": 6, "same": 6, "indic": 7, "overview": 8, "futur": 8, "direct": 8, "usag": [8, 40], "increment": [8, 37, 40], "part": [8, 33, 37], "configur": [8, 33, 36, 37, 39, 40], "command": [8, 32], "line": [8, 32], "option": [8, 37], "us": [8, 36], "script": 8, "develop": 8, "licens": 8, "bumpvers": [9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31], "subpackag": 9, "submodul": [9, 15], "packag": [9, 15], "data": [9, 13, 14, 15, 17, 18, 19, 22, 24, 25, 26, 27, 29, 30, 31], "api": [9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31], "__main__": 10, "alias": 11, "modul": [11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31], "class": [11, 19, 22, 23, 24, 25, 29, 30, 31], "autocast": 12, "function": [12, 13, 14, 15, 16, 17, 18, 20, 22, 23, 25, 26, 27, 28, 30, 31, 37], "cli": 14, "config": [15, 16, 17, 18, 19, 20], "creat": [16, 39], "files_legaci": 18, "model": 19, "util": [20, 28], "except": 21, "indented_logg": 24, "scm": 25, "show": [26, 40], "ui": 27, "version_part": [29, 40], "visual": [30, 39], "yaml_dump": 31, "interfac": 32, "global": 33, "allow_dirti": 33, "commit_arg": 33, "tag": 33, "sign_tag": 33, "tag_nam": 33, "tag_messag": 33, "current_vers": 33, "pars": 33, "serial": 33, "search": [33, 36, 40], "ignore_missing_vers": 33, "toml": 33, "exampl": [33, 39], "ini": 33, "specif": 33, "valu": [33, 37], "optional_valu": 33, "first_valu": 33, "independ": [33, 37], "filenam": 33, "glob": 33, "context": 34, "escap": 34, "charact": [34, 36], "date": 34, "time": 34, "field": 34, "sourc": 34, "manag": 34, "environ": 34, "variabl": 34, "refer": [35, 37], "templat": 36, "string": 36, "regular": 36, "express": 36, "special": 36, "tutori": 38, "semant": 39, "default": 39, "path": 39, "support": 39, "releas": 39, "autom": 39, "number": 39, "pre_n": 39, "note": 40, "warn": 40, "inform": 40, "without": 40}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 60}, "alltitles": {"Changelog": [[0, "changelog"], [8, "changelog"]], "0.17.1 (2024-01-25)": [[0, "id1"]], "Fixes": [[0, "fixes"], [0, "id3"], [0, "id5"], [0, "id7"], [0, "id12"], [0, "id14"], [0, "id16"], [0, "id19"], [0, "id23"], [0, "id26"], [0, "id30"], [0, "id35"], [0, "id45"], [0, "id50"], [0, "id59"], [0, "id62"], [0, "id66"], [0, "id70"], [0, "id73"], [0, "id78"], [0, "id81"], [0, "id86"], [0, "id91"]], "0.17.0 (2024-01-22)": [[0, "id2"]], "New": [[0, "new"], [0, "id9"], [0, "id17"], [0, "id27"], [0, "id31"], [0, "id36"], [0, "id46"], [0, "id55"], [0, "id57"], [0, "id63"], [0, "id67"], [0, "id74"], [0, "id82"], [0, "id87"], [0, "id92"]], "Updates": [[0, "updates"], [0, "id21"], [0, "id24"], [0, "id28"], [0, "id33"], [0, "id38"], [0, "id41"], [0, "id43"], [0, "id48"], [0, "id53"], [0, "id68"], [0, "id76"], [0, "id84"], [0, "id89"], [0, "id94"]], "0.16.2 (2024-01-13)": [[0, "id4"]], "Other": [[0, "other"], [0, "id10"], [0, "id20"], [0, "id32"], [0, "id37"], [0, "id40"], [0, "id47"], [0, "id52"], [0, "id60"], [0, "id64"], [0, "id71"], [0, "id75"], [0, "id79"], [0, "id83"], [0, "id88"], [0, "id93"]], "0.16.1 (2024-01-06)": [[0, "id6"]], "0.16.0 (2024-01-05)": [[0, "id8"]], "0.15.4 (2023-12-29)": [[0, "id11"]], "0.15.3 (2023-12-18)": [[0, "id13"]], "0.15.2 (2023-12-18)": [[0, "id15"]], "0.15.1 (2023-12-18)": [[0, "id18"]], "0.15.0 (2023-12-16)": [[0, "id22"]], "0.14.0 (2023-12-15)": [[0, "id25"]], "0.13.0 (2023-12-06)": [[0, "id29"]], "0.12.0 (2023-11-04)": [[0, "id34"]], "0.11.0 (2023-09-26)": [[0, "id39"]], "0.10.0 (2023-09-05)": [[0, "id42"]], "0.9.3 (2023-08-25)": [[0, "id44"]], "0.9.2 (2023-08-07)": [[0, "id49"]], "0.9.1 (2023-08-03)": [[0, "id51"]], "0.9.0 (2023-08-03)": [[0, "id54"]], "0.8.0 (2023-07-13)": [[0, "id56"]], "0.7.1 (2023-07-12)": [[0, "id58"]], "0.7.0 (2023-07-10)": [[0, "id61"]], "0.6.0 (2023-06-23)": [[0, "id65"]], "0.5.1 (2023-06-14)": [[0, "id69"]], "0.5.0 (2023-06-12)": [[0, "id72"]], "0.4.1 (2023-06-09)": [[0, "id77"]], "0.4.0 (2023-04-20)": [[0, "id80"]], "0.3.0 (2023-04-17)": [[0, "id85"]], "0.2.0 (2023-04-14)": [[0, "id90"]], "0.1.0 (2023-03-24)": [[0, "id95"]], "Contributing to Bump My Version": [[1, "contributing-to-bump-my-version"]], "Table of Contents": [[1, "table-of-contents"]], "Code of Conduct": [[1, "code-of-conduct"]], "I Have a Question": [[1, "i-have-a-question"]], "Reporting Bugs": [[1, "reporting-bugs"]], "Before Submitting a Bug Report": [[1, "before-submitting-a-bug-report"]], "How Do I Submit a Good Bug Report?": [[1, "how-do-i-submit-a-good-bug-report"]], "Suggesting Enhancements": [[1, "suggesting-enhancements"]], "Before Submitting an Enhancement": [[1, "before-submitting-an-enhancement"]], "How Do I Submit a Good Enhancement Suggestion?": [[1, "how-do-i-submit-a-good-enhancement-suggestion"]], "Your First Code Contribution": [[1, "your-first-code-contribution"]], "Setup": [[1, "setup"]], "Run tests": [[1, "run-tests"]], "Install Pre-commit Hooks": [[1, "install-pre-commit-hooks"]], "Improving The Documentation": [[1, "improving-the-documentation"]], "Styleguides": [[1, "styleguides"]], "Coding Style": [[1, "coding-style"]], "Commit Messages": [[1, "commit-messages"]], "Join The Project Team": [[1, "join-the-project-team"]], "Attribution": [[1, "attribution"]], "Explanation": [[2, "explanation"]], "Avoiding incorrect replacements": [[3, "avoiding-incorrect-replacements"]], "Custom version formats in different files": [[4, "custom-version-formats-in-different-files"]], "How-To Guides": [[5, "how-to-guides"]], "Multiple replacements within the same file": [[6, "multiple-replacements-within-the-same-file"]], "Bump My Version": [[7, "bump-my-version"], [8, "bump-my-version"]], "Contents": [[7, null]], "Indices and tables": [[7, "indices-and-tables"]], "Overview": [[8, "overview"]], "Future Direction": [[8, "future-direction"]], "Installation": [[8, "installation"]], "Usage for version incrementing": [[8, "usage-for-version-incrementing"]], "part": [[8, "part"]], "file": [[8, "file"]], "Configuration file": [[8, "configuration-file"]], "Command-line Options": [[8, "command-line-options"]], "Using bump-my-version in a script": [[8, "using-bump-my-version-in-a-script"]], "Development & Contributing": [[8, "development-contributing"]], "License": [[8, "license"]], "bumpversion": [[9, "module-bumpversion"]], "Subpackages": [[9, "subpackages"]], "Submodules": [[9, "submodules"], [15, "submodules"]], "Package Contents": [[9, "package-contents"], [15, "package-contents"]], "Data": [[9, "data"], [13, "data"], [14, "data"], [15, "data"], [17, "data"], [18, "data"], [19, "data"], [22, "data"], [24, "data"], [25, "data"], [26, "data"], [27, "data"], [29, "data"], [30, "data"], [31, "data"]], "API": [[9, "api"], [11, "api"], [12, "api"], [13, "api"], [14, "api"], [15, "api"], [16, "api"], [17, "api"], [18, "api"], [19, "api"], [20, "api"], [21, "api"], [22, "api"], [23, "api"], [24, "api"], [25, "api"], [26, "api"], [27, "api"], [28, "api"], [29, "api"], [30, "api"], [31, "api"]], "bumpversion.__main__": [[10, "module-bumpversion.__main__"]], "bumpversion.aliases": [[11, "module-bumpversion.aliases"]], "Module Contents": [[11, "module-contents"], [12, "module-contents"], [13, "module-contents"], [14, "module-contents"], [16, "module-contents"], [17, "module-contents"], [18, "module-contents"], [19, "module-contents"], [20, "module-contents"], [21, "module-contents"], [22, "module-contents"], [23, "module-contents"], [24, "module-contents"], [25, "module-contents"], [26, "module-contents"], [27, "module-contents"], [28, "module-contents"], [29, "module-contents"], [30, "module-contents"], [31, "module-contents"]], "Classes": [[11, "classes"], [19, "classes"], [22, "classes"], [23, "classes"], [24, "classes"], [25, "classes"], [29, "classes"], [30, "classes"], [31, "classes"]], "bumpversion.autocast": [[12, "module-bumpversion.autocast"]], "Functions": [[12, "functions"], [13, "functions"], [14, "functions"], [15, "functions"], [16, "functions"], [17, "functions"], [18, "functions"], [20, "functions"], [22, "functions"], [25, "functions"], [26, "functions"], [27, "functions"], [28, "functions"], [30, "functions"], [31, "functions"]], "bumpversion.bump": [[13, "module-bumpversion.bump"]], "bumpversion.cli": [[14, "module-bumpversion.cli"]], "bumpversion.config": [[15, "module-bumpversion.config"]], "bumpversion.config.create": [[16, "module-bumpversion.config.create"]], "bumpversion.config.files": [[17, "module-bumpversion.config.files"]], "bumpversion.config.files_legacy": [[18, "module-bumpversion.config.files_legacy"]], "bumpversion.config.models": [[19, "module-bumpversion.config.models"]], "bumpversion.config.utils": [[20, "module-bumpversion.config.utils"]], "bumpversion.exceptions": [[21, "module-bumpversion.exceptions"]], "bumpversion.files": [[22, "module-bumpversion.files"]], "bumpversion.functions": [[23, "module-bumpversion.functions"]], "bumpversion.indented_logger": [[24, "module-bumpversion.indented_logger"]], "bumpversion.scm": [[25, "module-bumpversion.scm"]], "bumpversion.show": [[26, "module-bumpversion.show"]], "bumpversion.ui": [[27, "module-bumpversion.ui"]], "bumpversion.utils": [[28, "module-bumpversion.utils"]], "bumpversion.version_part": [[29, "module-bumpversion.version_part"]], "bumpversion.visualize": [[30, "module-bumpversion.visualize"]], "bumpversion.yaml_dump": [[31, "module-bumpversion.yaml_dump"]], "Command-line Interface": [[32, "command-line-interface"]], "Configuration": [[33, "configuration"]], "Configuration files": [[33, "configuration-files"]], "Global Configuration": [[33, "global-configuration"]], "allow_dirty": [[33, "allow-dirty"]], "commit": [[33, "commit"]], "message": [[33, "message"]], "commit_args": [[33, "commit-args"]], "tag": [[33, "tag"]], "sign_tags": [[33, "sign-tags"]], "tag_name": [[33, "tag-name"]], "tag_message": [[33, "tag-message"]], "current_version": [[33, "current-version"]], "parse": [[33, "parse"], [33, "id3"]], "serialize": [[33, "serialize"], [33, "id4"]], "search": [[33, "search"], [33, "id5"]], "replace": [[33, "replace"], [33, "id6"]], "ignore_missing_version": [[33, "ignore-missing-version"], [33, "id7"]], "TOML example": [[33, "toml-example"], [33, "id1"]], "INI-style example": [[33, "ini-style-example"], [33, "id2"]], "Version part-specific configuration": [[33, "version-part-specific-configuration"]], "values": [[33, "values"]], "optional_value": [[33, "optional-value"]], "first_value": [[33, "first-value"]], "independent": [[33, "independent"]], "File-specific configuration": [[33, "file-specific-configuration"]], "filename": [[33, "filename"]], "glob": [[33, "glob"]], "INI-style configuration files": [[33, "ini-style-configuration-files"]], "TOML configuration files": [[33, "toml-configuration-files"]], "Formatting context": [[34, "formatting-context"]], "Escaped characters": [[34, "escaped-characters"]], "Date and time fields": [[34, "date-and-time-fields"]], "Source code management fields": [[34, "source-code-management-fields"]], "Version fields": [[34, "version-fields"]], "Environment variables": [[34, "environment-variables"]], "Reference": [[35, "reference"], [37, "reference"]], "Search and replace configuration": [[36, "search-and-replace-configuration"]], "Using template strings": [[36, "using-template-strings"]], "Using regular expressions": [[36, "using-regular-expressions"]], "Regular expression special characters": [[36, "regular-expression-special-characters"]], "Version parts": [[37, "version-parts"]], "Version configuration": [[37, "version-configuration"]], "Version part configuration": [[37, "version-part-configuration"]], "Incrementing functions": [[37, "incrementing-functions"]], "Optional values": [[37, "optional-values"]], "First Values": [[37, "first-values"]], "Independent Values": [[37, "independent-values"]], "Tutorials": [[38, "tutorials"]], "Semantic versioning example": [[39, "semantic-versioning-example"]], "Create a default configuration": [[39, "create-a-default-configuration"]], "Visualizing the versioning path": [[39, "visualizing-the-versioning-path"]], "Supporting pre-release versions": [[39, "supporting-pre-release-versions"]], "Visualizing the new versioning path": [[39, "visualizing-the-new-versioning-path"]], "Automating the pre-release numbering": [[39, "automating-the-pre-release-numbering"]], "Visualizing the pre_n versioning path": [[39, "visualizing-the-pre-n-versioning-path"]], "Usage": [[40, "usage"]], "NOTE": [[40, null], [40, null]], "WARNING": [[40, null]], "Incrementing a version": [[40, "incrementing-a-version"]], "VERSION_PART": [[40, "version-part"]], "FILES": [[40, "files"]], "Showing configuration information": [[40, "showing-configuration-information"]], "Searching and replacing without bumping": [[40, "searching-and-replacing-without-bumping"]]}, "indexentries": {"__version__ (in module bumpversion)": [[9, "bumpversion.__version__"]], "bumpversion": [[9, "module-bumpversion"]], "module": [[9, "module-bumpversion"], [10, "module-bumpversion.__main__"], [11, "module-bumpversion.aliases"], [12, "module-bumpversion.autocast"], [13, "module-bumpversion.bump"], [14, "module-bumpversion.cli"], [15, "module-bumpversion.config"], [16, "module-bumpversion.config.create"], [17, "module-bumpversion.config.files"], [18, "module-bumpversion.config.files_legacy"], [19, "module-bumpversion.config.models"], [20, "module-bumpversion.config.utils"], [21, "module-bumpversion.exceptions"], [22, "module-bumpversion.files"], [23, "module-bumpversion.functions"], [24, "module-bumpversion.indented_logger"], [25, "module-bumpversion.scm"], [26, "module-bumpversion.show"], [27, "module-bumpversion.ui"], [28, "module-bumpversion.utils"], [29, "module-bumpversion.version_part"], [30, "module-bumpversion.visualize"], [31, "module-bumpversion.yaml_dump"]], "bumpversion.__main__": [[10, "module-bumpversion.__main__"]], "aliasedgroup (class in bumpversion.aliases)": [[11, "bumpversion.aliases.AliasedGroup"]], "bumpversion.aliases": [[11, "module-bumpversion.aliases"]], "get_command() (bumpversion.aliases.aliasedgroup method)": [[11, "bumpversion.aliases.AliasedGroup.get_command"]], "resolve_command() (bumpversion.aliases.aliasedgroup method)": [[11, "bumpversion.aliases.AliasedGroup.resolve_command"]], "autocast_value() (in module bumpversion.autocast)": [[12, "bumpversion.autocast.autocast_value"]], "boolify() (in module bumpversion.autocast)": [[12, "bumpversion.autocast.boolify"]], "bumpversion.autocast": [[12, "module-bumpversion.autocast"]], "listify() (in module bumpversion.autocast)": [[12, "bumpversion.autocast.listify"]], "noneify() (in module bumpversion.autocast)": [[12, "bumpversion.autocast.noneify"]], "bumpversion.bump": [[13, "module-bumpversion.bump"]], "commit_and_tag() (in module bumpversion.bump)": [[13, "bumpversion.bump.commit_and_tag"]], "do_bump() (in module bumpversion.bump)": [[13, "bumpversion.bump.do_bump"]], "get_next_version() (in module bumpversion.bump)": [[13, "bumpversion.bump.get_next_version"]], "logger (in module bumpversion.bump)": [[13, "bumpversion.bump.logger"]], "bump() (in module bumpversion.cli)": [[14, "bumpversion.cli.bump"]], "bumpversion.cli": [[14, "module-bumpversion.cli"]], "cli() (in module bumpversion.cli)": [[14, "bumpversion.cli.cli"]], "logger (in module bumpversion.cli)": [[14, "bumpversion.cli.logger"]], "replace() (in module bumpversion.cli)": [[14, "bumpversion.cli.replace"]], "sample_config() (in module bumpversion.cli)": [[14, "bumpversion.cli.sample_config"]], "show() (in module bumpversion.cli)": [[14, "bumpversion.cli.show"]], "show_bump() (in module bumpversion.cli)": [[14, "bumpversion.cli.show_bump"]], "defaults (in module bumpversion.config)": [[15, "bumpversion.config.DEFAULTS"]], "bumpversion.config": [[15, "module-bumpversion.config"]], "check_current_version() (in module bumpversion.config)": [[15, "bumpversion.config.check_current_version"]], "get_configuration() (in module bumpversion.config)": [[15, "bumpversion.config.get_configuration"]], "logger (in module bumpversion.config)": [[15, "bumpversion.config.logger"]], "bumpversion.config.create": [[16, "module-bumpversion.config.create"]], "create_configuration() (in module bumpversion.config.create)": [[16, "bumpversion.config.create.create_configuration"]], "get_defaults_from_dest() (in module bumpversion.config.create)": [[16, "bumpversion.config.create.get_defaults_from_dest"]], "config_file_search_order (in module bumpversion.config.files)": [[17, "bumpversion.config.files.CONFIG_FILE_SEARCH_ORDER"]], "bumpversion.config.files": [[17, "module-bumpversion.config.files"]], "find_config_file() (in module bumpversion.config.files)": [[17, "bumpversion.config.files.find_config_file"]], "logger (in module bumpversion.config.files)": [[17, "bumpversion.config.files.logger"]], "read_config_file() (in module bumpversion.config.files)": [[17, "bumpversion.config.files.read_config_file"]], "read_toml_file() (in module bumpversion.config.files)": [[17, "bumpversion.config.files.read_toml_file"]], "update_config_file() (in module bumpversion.config.files)": [[17, "bumpversion.config.files.update_config_file"]], "bumpversion.config.files_legacy": [[18, "module-bumpversion.config.files_legacy"]], "logger (in module bumpversion.config.files_legacy)": [[18, "bumpversion.config.files_legacy.logger"]], "read_ini_file() (in module bumpversion.config.files_legacy)": [[18, "bumpversion.config.files_legacy.read_ini_file"]], "update_ini_config_file() (in module bumpversion.config.files_legacy)": [[18, "bumpversion.config.files_legacy.update_ini_config_file"]], "config (class in bumpversion.config.models)": [[19, "bumpversion.config.models.Config"]], "filechange (class in bumpversion.config.models)": [[19, "bumpversion.config.models.FileChange"]], "versionpartconfig (class in bumpversion.config.models)": [[19, "bumpversion.config.models.VersionPartConfig"]], "__hash__() (bumpversion.config.models.filechange method)": [[19, "bumpversion.config.models.FileChange.__hash__"]], "_resolve_filemap() (bumpversion.config.models.config method)": [[19, "bumpversion.config.models.Config._resolve_filemap"]], "_resolved_filemap (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config._resolved_filemap"]], "add_files() (bumpversion.config.models.config method)": [[19, "bumpversion.config.models.Config.add_files"]], "allow_dirty (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.allow_dirty"]], "bumpversion.config.models": [[19, "module-bumpversion.config.models"]], "commit (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.commit"]], "commit_args (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.commit_args"]], "current_version (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.current_version"]], "excluded_paths (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.excluded_paths"]], "filename (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.filename"]], "files (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.files"]], "files_to_modify (bumpversion.config.models.config property)": [[19, "bumpversion.config.models.Config.files_to_modify"]], "first_value (bumpversion.config.models.versionpartconfig attribute)": [[19, "bumpversion.config.models.VersionPartConfig.first_value"]], "get_search_pattern() (bumpversion.config.models.filechange method)": [[19, "bumpversion.config.models.FileChange.get_search_pattern"]], "glob (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.glob"]], "ignore_missing_version (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.ignore_missing_version"]], "ignore_missing_version (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.ignore_missing_version"]], "included_paths (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.included_paths"]], "independent (bumpversion.config.models.versionpartconfig attribute)": [[19, "bumpversion.config.models.VersionPartConfig.independent"]], "key_path (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.key_path"]], "logger (in module bumpversion.config.models)": [[19, "bumpversion.config.models.logger"]], "message (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.message"]], "model_config (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.model_config"]], "optional_value (bumpversion.config.models.versionpartconfig attribute)": [[19, "bumpversion.config.models.VersionPartConfig.optional_value"]], "parse (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.parse"]], "parse (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.parse"]], "parts (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.parts"]], "regex (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.regex"]], "regex (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.regex"]], "replace (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.replace"]], "replace (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.replace"]], "resolved_filemap (bumpversion.config.models.config property)": [[19, "bumpversion.config.models.Config.resolved_filemap"]], "scm_info (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.scm_info"]], "search (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.search"]], "search (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.search"]], "serialize (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.serialize"]], "serialize (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.serialize"]], "sign_tags (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.sign_tags"]], "tag (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.tag"]], "tag_message (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.tag_message"]], "tag_name (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.tag_name"]], "values (bumpversion.config.models.versionpartconfig attribute)": [[19, "bumpversion.config.models.VersionPartConfig.values"]], "version_config (bumpversion.config.models.config property)": [[19, "bumpversion.config.models.Config.version_config"]], "bumpversion.config.utils": [[20, "module-bumpversion.config.utils"]], "get_all_file_configs() (in module bumpversion.config.utils)": [[20, "bumpversion.config.utils.get_all_file_configs"]], "get_all_part_configs() (in module bumpversion.config.utils)": [[20, "bumpversion.config.utils.get_all_part_configs"]], "resolve_glob_files() (in module bumpversion.config.utils)": [[20, "bumpversion.config.utils.resolve_glob_files"]], "badinputerror": [[21, "bumpversion.exceptions.BadInputError"]], "bumpversionerror": [[21, "bumpversion.exceptions.BumpVersionError"]], "configurationerror": [[21, "bumpversion.exceptions.ConfigurationError"]], "dirtyworkingdirectoryerror": [[21, "bumpversion.exceptions.DirtyWorkingDirectoryError"]], "formattingerror": [[21, "bumpversion.exceptions.FormattingError"]], "invalidversionparterror": [[21, "bumpversion.exceptions.InvalidVersionPartError"]], "missingvalueerror": [[21, "bumpversion.exceptions.MissingValueError"]], "signedtagserror": [[21, "bumpversion.exceptions.SignedTagsError"]], "versionnotfounderror": [[21, "bumpversion.exceptions.VersionNotFoundError"]], "bumpversion.exceptions": [[21, "module-bumpversion.exceptions"]], "configuredfile (class in bumpversion.files)": [[22, "bumpversion.files.ConfiguredFile"]], "datafileupdater (class in bumpversion.files)": [[22, "bumpversion.files.DataFileUpdater"]], "fileupdater (class in bumpversion.files)": [[22, "bumpversion.files.FileUpdater"]], "__repr__() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.__repr__"]], "__str__() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.__str__"]], "_contains_change_pattern() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile._contains_change_pattern"]], "_update_toml_file() (bumpversion.files.datafileupdater method)": [[22, "bumpversion.files.DataFileUpdater._update_toml_file"]], "bumpversion.files": [[22, "module-bumpversion.files"]], "contains_pattern() (in module bumpversion.files)": [[22, "bumpversion.files.contains_pattern"]], "get_file_contents() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.get_file_contents"]], "log_changes() (in module bumpversion.files)": [[22, "bumpversion.files.log_changes"]], "logger (in module bumpversion.files)": [[22, "bumpversion.files.logger"]], "make_file_change() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.make_file_change"]], "modify_files() (in module bumpversion.files)": [[22, "bumpversion.files.modify_files"]], "resolve_file_config() (in module bumpversion.files)": [[22, "bumpversion.files.resolve_file_config"]], "update_file() (bumpversion.files.datafileupdater method)": [[22, "bumpversion.files.DataFileUpdater.update_file"]], "update_file() (bumpversion.files.fileupdater method)": [[22, "bumpversion.files.FileUpdater.update_file"]], "write_file_contents() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.write_file_contents"]], "first_numeric (bumpversion.functions.numericfunction attribute)": [[23, "bumpversion.functions.NumericFunction.FIRST_NUMERIC"]], "numericfunction (class in bumpversion.functions)": [[23, "bumpversion.functions.NumericFunction"]], "partfunction (class in bumpversion.functions)": [[23, "bumpversion.functions.PartFunction"]], "valuesfunction (class in bumpversion.functions)": [[23, "bumpversion.functions.ValuesFunction"]], "bump() (bumpversion.functions.numericfunction method)": [[23, "bumpversion.functions.NumericFunction.bump"]], "bump() (bumpversion.functions.partfunction method)": [[23, "bumpversion.functions.PartFunction.bump"]], "bump() (bumpversion.functions.valuesfunction method)": [[23, "bumpversion.functions.ValuesFunction.bump"]], "bumpversion.functions": [[23, "module-bumpversion.functions"]], "first_value (bumpversion.functions.partfunction attribute)": [[23, "bumpversion.functions.PartFunction.first_value"]], "independent (bumpversion.functions.partfunction attribute)": [[23, "bumpversion.functions.PartFunction.independent"]], "optional_value (bumpversion.functions.partfunction attribute)": [[23, "bumpversion.functions.PartFunction.optional_value"]], "current_indent (in module bumpversion.indented_logger)": [[24, "bumpversion.indented_logger.CURRENT_INDENT"]], "indentedloggeradapter (class in bumpversion.indented_logger)": [[24, "bumpversion.indented_logger.IndentedLoggerAdapter"]], "bumpversion.indented_logger": [[24, "module-bumpversion.indented_logger"]], "current_indent (bumpversion.indented_logger.indentedloggeradapter property)": [[24, "bumpversion.indented_logger.IndentedLoggerAdapter.current_indent"]], "dedent() (bumpversion.indented_logger.indentedloggeradapter method)": [[24, "bumpversion.indented_logger.IndentedLoggerAdapter.dedent"]], "indent() (bumpversion.indented_logger.indentedloggeradapter method)": [[24, "bumpversion.indented_logger.IndentedLoggerAdapter.indent"]], "indent_str (bumpversion.indented_logger.indentedloggeradapter property)": [[24, "bumpversion.indented_logger.IndentedLoggerAdapter.indent_str"]], "process() (bumpversion.indented_logger.indentedloggeradapter method)": [[24, "bumpversion.indented_logger.IndentedLoggerAdapter.process"]], "reset() (bumpversion.indented_logger.indentedloggeradapter method)": [[24, "bumpversion.indented_logger.IndentedLoggerAdapter.reset"]], "git (class in bumpversion.scm)": [[25, "bumpversion.scm.Git"]], "mercurial (class in bumpversion.scm)": [[25, "bumpversion.scm.Mercurial"]], "scminfo (class in bumpversion.scm)": [[25, "bumpversion.scm.SCMInfo"]], "sourcecodemanager (class in bumpversion.scm)": [[25, "bumpversion.scm.SourceCodeManager"]], "_all_tags_command (bumpversion.scm.git attribute)": [[25, "bumpversion.scm.Git._ALL_TAGS_COMMAND"]], "_all_tags_command (bumpversion.scm.mercurial attribute)": [[25, "bumpversion.scm.Mercurial._ALL_TAGS_COMMAND"]], "_all_tags_command (bumpversion.scm.sourcecodemanager attribute)": [[25, "bumpversion.scm.SourceCodeManager._ALL_TAGS_COMMAND"]], "_commit_command (bumpversion.scm.git attribute)": [[25, "bumpversion.scm.Git._COMMIT_COMMAND"]], "_commit_command (bumpversion.scm.mercurial attribute)": [[25, "bumpversion.scm.Mercurial._COMMIT_COMMAND"]], "_commit_command (bumpversion.scm.sourcecodemanager attribute)": [[25, "bumpversion.scm.SourceCodeManager._COMMIT_COMMAND"]], "_test_usable_command (bumpversion.scm.git attribute)": [[25, "bumpversion.scm.Git._TEST_USABLE_COMMAND"]], "_test_usable_command (bumpversion.scm.mercurial attribute)": [[25, "bumpversion.scm.Mercurial._TEST_USABLE_COMMAND"]], "_test_usable_command (bumpversion.scm.sourcecodemanager attribute)": [[25, "bumpversion.scm.SourceCodeManager._TEST_USABLE_COMMAND"]], "__repr__() (bumpversion.scm.scminfo method)": [[25, "bumpversion.scm.SCMInfo.__repr__"]], "__repr__() (bumpversion.scm.sourcecodemanager method)": [[25, "bumpversion.scm.SourceCodeManager.__repr__"]], "__str__() (bumpversion.scm.scminfo method)": [[25, "bumpversion.scm.SCMInfo.__str__"]], "__str__() (bumpversion.scm.sourcecodemanager method)": [[25, "bumpversion.scm.SourceCodeManager.__str__"]], "add_path() (bumpversion.scm.git class method)": [[25, "bumpversion.scm.Git.add_path"]], "add_path() (bumpversion.scm.mercurial class method)": [[25, "bumpversion.scm.Mercurial.add_path"]], "add_path() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.add_path"]], "assert_nondirty() (bumpversion.scm.git class method)": [[25, "bumpversion.scm.Git.assert_nondirty"]], "assert_nondirty() (bumpversion.scm.mercurial class method)": [[25, "bumpversion.scm.Mercurial.assert_nondirty"]], "assert_nondirty() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.assert_nondirty"]], "branch_name (bumpversion.scm.scminfo attribute)": [[25, "bumpversion.scm.SCMInfo.branch_name"]], "bumpversion.scm": [[25, "module-bumpversion.scm"]], "commit() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.commit"]], "commit_sha (bumpversion.scm.scminfo attribute)": [[25, "bumpversion.scm.SCMInfo.commit_sha"]], "commit_to_scm() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.commit_to_scm"]], "current_version (bumpversion.scm.scminfo attribute)": [[25, "bumpversion.scm.SCMInfo.current_version"]], "dirty (bumpversion.scm.scminfo attribute)": [[25, "bumpversion.scm.SCMInfo.dirty"]], "distance_to_latest_tag (bumpversion.scm.scminfo attribute)": [[25, "bumpversion.scm.SCMInfo.distance_to_latest_tag"]], "get_all_tags() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.get_all_tags"]], "get_scm_info() (in module bumpversion.scm)": [[25, "bumpversion.scm.get_scm_info"]], "get_version_from_tag() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.get_version_from_tag"]], "is_usable() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.is_usable"]], "latest_tag_info() (bumpversion.scm.git class method)": [[25, "bumpversion.scm.Git.latest_tag_info"]], "latest_tag_info() (bumpversion.scm.mercurial class method)": [[25, "bumpversion.scm.Mercurial.latest_tag_info"]], "latest_tag_info() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.latest_tag_info"]], "logger (in module bumpversion.scm)": [[25, "bumpversion.scm.logger"]], "short_branch_name (bumpversion.scm.scminfo attribute)": [[25, "bumpversion.scm.SCMInfo.short_branch_name"]], "tag() (bumpversion.scm.git class method)": [[25, "bumpversion.scm.Git.tag"]], "tag() (bumpversion.scm.mercurial class method)": [[25, "bumpversion.scm.Mercurial.tag"]], "tag() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.tag"]], "tag_in_scm() (bumpversion.scm.sourcecodemanager class method)": [[25, "bumpversion.scm.SourceCodeManager.tag_in_scm"]], "tool (bumpversion.scm.scminfo attribute)": [[25, "bumpversion.scm.SCMInfo.tool"]], "outputters (in module bumpversion.show)": [[26, "bumpversion.show.OUTPUTTERS"]], "bumpversion.show": [[26, "module-bumpversion.show"]], "do_show() (in module bumpversion.show)": [[26, "bumpversion.show.do_show"]], "log_list() (in module bumpversion.show)": [[26, "bumpversion.show.log_list"]], "output_default() (in module bumpversion.show)": [[26, "bumpversion.show.output_default"]], "output_json() (in module bumpversion.show)": [[26, "bumpversion.show.output_json"]], "output_yaml() (in module bumpversion.show)": [[26, "bumpversion.show.output_yaml"]], "resolve_name() (in module bumpversion.show)": [[26, "bumpversion.show.resolve_name"]], "verbosity (in module bumpversion.ui)": [[27, "bumpversion.ui.VERBOSITY"]], "bumpversion.ui": [[27, "module-bumpversion.ui"]], "get_indented_logger() (in module bumpversion.ui)": [[27, "bumpversion.ui.get_indented_logger"]], "logger (in module bumpversion.ui)": [[27, "bumpversion.ui.logger"]], "print_error() (in module bumpversion.ui)": [[27, "bumpversion.ui.print_error"]], "print_info() (in module bumpversion.ui)": [[27, "bumpversion.ui.print_info"]], "print_warning() (in module bumpversion.ui)": [[27, "bumpversion.ui.print_warning"]], "setup_logging() (in module bumpversion.ui)": [[27, "bumpversion.ui.setup_logging"]], "base_context() (in module bumpversion.utils)": [[28, "bumpversion.utils.base_context"]], "bumpversion.utils": [[28, "module-bumpversion.utils"]], "extract_regex_flags() (in module bumpversion.utils)": [[28, "bumpversion.utils.extract_regex_flags"]], "get_context() (in module bumpversion.utils)": [[28, "bumpversion.utils.get_context"]], "get_nested_value() (in module bumpversion.utils)": [[28, "bumpversion.utils.get_nested_value"]], "get_overrides() (in module bumpversion.utils)": [[28, "bumpversion.utils.get_overrides"]], "key_val_string() (in module bumpversion.utils)": [[28, "bumpversion.utils.key_val_string"]], "labels_for_format() (in module bumpversion.utils)": [[28, "bumpversion.utils.labels_for_format"]], "prefixed_environ() (in module bumpversion.utils)": [[28, "bumpversion.utils.prefixed_environ"]], "recursive_sort_dict() (in module bumpversion.utils)": [[28, "bumpversion.utils.recursive_sort_dict"]], "set_nested_value() (in module bumpversion.utils)": [[28, "bumpversion.utils.set_nested_value"]], "version (class in bumpversion.version_part)": [[29, "bumpversion.version_part.Version"]], "versionconfig (class in bumpversion.version_part)": [[29, "bumpversion.version_part.VersionConfig"]], "versionpart (class in bumpversion.version_part)": [[29, "bumpversion.version_part.VersionPart"]], "__eq__() (bumpversion.version_part.version method)": [[29, "bumpversion.version_part.Version.__eq__"]], "__eq__() (bumpversion.version_part.versionconfig method)": [[29, "bumpversion.version_part.VersionConfig.__eq__"]], "__eq__() (bumpversion.version_part.versionpart method)": [[29, "bumpversion.version_part.VersionPart.__eq__"]], "__format__() (bumpversion.version_part.versionpart method)": [[29, "bumpversion.version_part.VersionPart.__format__"]], "__getitem__() (bumpversion.version_part.version method)": [[29, "bumpversion.version_part.Version.__getitem__"]], "__iter__() (bumpversion.version_part.version method)": [[29, "bumpversion.version_part.Version.__iter__"]], "__len__() (bumpversion.version_part.version method)": [[29, "bumpversion.version_part.Version.__len__"]], "__repr__() (bumpversion.version_part.version method)": [[29, "bumpversion.version_part.Version.__repr__"]], "__repr__() (bumpversion.version_part.versionconfig method)": [[29, "bumpversion.version_part.VersionConfig.__repr__"]], "__repr__() (bumpversion.version_part.versionpart method)": [[29, "bumpversion.version_part.VersionPart.__repr__"]], "_choose_serialize_format() (bumpversion.version_part.versionconfig method)": [[29, "bumpversion.version_part.VersionConfig._choose_serialize_format"]], "_serialize() (bumpversion.version_part.versionconfig method)": [[29, "bumpversion.version_part.VersionConfig._serialize"]], "bump() (bumpversion.version_part.version method)": [[29, "bumpversion.version_part.Version.bump"]], "bump() (bumpversion.version_part.versionpart method)": [[29, "bumpversion.version_part.VersionPart.bump"]], "bumpversion.version_part": [[29, "module-bumpversion.version_part"]], "copy() (bumpversion.version_part.versionpart method)": [[29, "bumpversion.version_part.VersionPart.copy"]], "is_independent (bumpversion.version_part.versionpart property)": [[29, "bumpversion.version_part.VersionPart.is_independent"]], "is_optional (bumpversion.version_part.versionpart property)": [[29, "bumpversion.version_part.VersionPart.is_optional"]], "logger (in module bumpversion.version_part)": [[29, "bumpversion.version_part.logger"]], "null() (bumpversion.version_part.versionpart method)": [[29, "bumpversion.version_part.VersionPart.null"]], "order (bumpversion.version_part.versionconfig property)": [[29, "bumpversion.version_part.VersionConfig.order"]], "parse() (bumpversion.version_part.versionconfig method)": [[29, "bumpversion.version_part.VersionConfig.parse"]], "serialize() (bumpversion.version_part.versionconfig method)": [[29, "bumpversion.version_part.VersionConfig.serialize"]], "value (bumpversion.version_part.versionpart property)": [[29, "bumpversion.version_part.VersionPart.value"]], "box_chars (in module bumpversion.visualize)": [[30, "bumpversion.visualize.BOX_CHARS"]], "border (class in bumpversion.visualize)": [[30, "bumpversion.visualize.Border"]], "bumpversion.visualize": [[30, "module-bumpversion.visualize"]], "connection_str() (in module bumpversion.visualize)": [[30, "bumpversion.visualize.connection_str"]], "corner_bottom_left (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.corner_bottom_left"]], "corner_bottom_right (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.corner_bottom_right"]], "corner_top_left (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.corner_top_left"]], "corner_top_right (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.corner_top_right"]], "cross (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.cross"]], "divider_down (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.divider_down"]], "divider_left (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.divider_left"]], "divider_right (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.divider_right"]], "divider_up (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.divider_up"]], "filter_version_parts() (in module bumpversion.visualize)": [[30, "bumpversion.visualize.filter_version_parts"]], "labeled_line() (in module bumpversion.visualize)": [[30, "bumpversion.visualize.labeled_line"]], "lead_string() (in module bumpversion.visualize)": [[30, "bumpversion.visualize.lead_string"]], "line (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.line"]], "pipe (bumpversion.visualize.border attribute)": [[30, "bumpversion.visualize.Border.pipe"]], "visualize() (in module bumpversion.visualize)": [[30, "bumpversion.visualize.visualize"]], "dumperfunc (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.DumperFunc"]], "indent (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.INDENT"]], "yamldumpers (class in bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.YAMLDumpers"]], "yaml_dumpers (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.YAML_DUMPERS"]], "add_dumper() (bumpversion.yaml_dump.yamldumpers method)": [[31, "bumpversion.yaml_dump.YAMLDumpers.add_dumper"]], "bumpversion.yaml_dump": [[31, "module-bumpversion.yaml_dump"]], "dump() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.dump"]], "format_bool() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_bool"]], "format_date() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_date"]], "format_datetime() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_datetime"]], "format_dict() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_dict"]], "format_float() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_float"]], "format_int() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_int"]], "format_none() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_none"]], "format_sequence() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_sequence"]], "format_str() (in module bumpversion.yaml_dump)": [[31, "bumpversion.yaml_dump.format_str"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "contributing", "explanation/index", "howtos/avoid-incorrect-replacements", "howtos/custom-version-formats-by-file", "howtos/index", "howtos/multiple-replacements", "index", "readme", "reference/bumpversion/bumpversion", "reference/bumpversion/bumpversion.__main__", "reference/bumpversion/bumpversion.aliases", "reference/bumpversion/bumpversion.autocast", "reference/bumpversion/bumpversion.bump", "reference/bumpversion/bumpversion.cli", "reference/bumpversion/bumpversion.config", "reference/bumpversion/bumpversion.config.create", "reference/bumpversion/bumpversion.config.files", "reference/bumpversion/bumpversion.config.files_legacy", "reference/bumpversion/bumpversion.config.models", "reference/bumpversion/bumpversion.config.utils", "reference/bumpversion/bumpversion.exceptions", "reference/bumpversion/bumpversion.files", "reference/bumpversion/bumpversion.indented_logger", "reference/bumpversion/bumpversion.scm", "reference/bumpversion/bumpversion.show", "reference/bumpversion/bumpversion.ui", "reference/bumpversion/bumpversion.utils", "reference/bumpversion/bumpversion.version_part", "reference/bumpversion/bumpversion.versioning", "reference/bumpversion/bumpversion.versioning.conventions", "reference/bumpversion/bumpversion.versioning.functions", "reference/bumpversion/bumpversion.versioning.models", "reference/bumpversion/bumpversion.versioning.serialization", "reference/bumpversion/bumpversion.visualize", "reference/bumpversion/bumpversion.yaml_dump", "reference/cli", "reference/configuration", "reference/formatting-context", "reference/index", "reference/search-and-replace-config", "reference/version-parts", "tutorials/index", "tutorials/semantic-versioning-example", "usage"], "filenames": ["changelog.md", "contributing.md", "explanation/index.md", "howtos/avoid-incorrect-replacements.md", "howtos/custom-version-formats-by-file.md", "howtos/index.md", "howtos/multiple-replacements.md", "index.md", "readme.md", "reference/bumpversion/bumpversion.md", "reference/bumpversion/bumpversion.__main__.md", "reference/bumpversion/bumpversion.aliases.md", "reference/bumpversion/bumpversion.autocast.md", "reference/bumpversion/bumpversion.bump.md", "reference/bumpversion/bumpversion.cli.md", "reference/bumpversion/bumpversion.config.md", "reference/bumpversion/bumpversion.config.create.md", "reference/bumpversion/bumpversion.config.files.md", "reference/bumpversion/bumpversion.config.files_legacy.md", "reference/bumpversion/bumpversion.config.models.md", "reference/bumpversion/bumpversion.config.utils.md", "reference/bumpversion/bumpversion.exceptions.md", "reference/bumpversion/bumpversion.files.md", "reference/bumpversion/bumpversion.indented_logger.md", "reference/bumpversion/bumpversion.scm.md", "reference/bumpversion/bumpversion.show.md", "reference/bumpversion/bumpversion.ui.md", "reference/bumpversion/bumpversion.utils.md", "reference/bumpversion/bumpversion.version_part.md", "reference/bumpversion/bumpversion.versioning.md", "reference/bumpversion/bumpversion.versioning.conventions.md", "reference/bumpversion/bumpversion.versioning.functions.md", "reference/bumpversion/bumpversion.versioning.models.md", "reference/bumpversion/bumpversion.versioning.serialization.md", "reference/bumpversion/bumpversion.visualize.md", "reference/bumpversion/bumpversion.yaml_dump.md", "reference/cli.rst", "reference/configuration.md", "reference/formatting-context.md", "reference/index.md", "reference/search-and-replace-config.md", "reference/version-parts.md", "tutorials/index.md", "tutorials/semantic-versioning-example.md", "usage.md"], "titles": ["Changelog", "Contributing to Bump My Version", "Explanation", "Avoiding incorrect replacements", "Custom version formats in different files", "How-To Guides", "Multiple replacements within the same file", "Bump My Version", "Bump My Version", "bumpversion", "bumpversion.__main__", "bumpversion.aliases", "bumpversion.autocast", "bumpversion.bump", "bumpversion.cli", "bumpversion.config", "bumpversion.config.create", "bumpversion.config.files", "bumpversion.config.files_legacy", "bumpversion.config.models", "bumpversion.config.utils", "bumpversion.exceptions", "bumpversion.files", "bumpversion.indented_logger", "bumpversion.scm", "bumpversion.show", "bumpversion.ui", "bumpversion.utils", "bumpversion.version_part", "bumpversion.versioning", "bumpversion.versioning.conventions", "bumpversion.versioning.functions", "bumpversion.versioning.models", "bumpversion.versioning.serialization", "bumpversion.visualize", "bumpversion.yaml_dump", "Command-line Interface", "Configuration", "Formatting context", "Reference", "Search and replace configuration", "Version parts", "Tutorials", "Semantic versioning example", "Usage"], "terms": {"compar": [0, 6, 41], "full": [0, 4, 8, 11, 43], "differ": [0, 1, 5, 6, 7, 37, 41], "bad": [0, 21], "error": [0, 1, 26, 33], "check": [0, 1, 8, 22, 34], "scm": [0, 9, 19, 27, 39], "10e5d7d": 0, "miss": [0, 21, 37, 43], "current": [0, 1, 6, 8, 13, 14, 15, 17, 18, 22, 23, 24, 25, 28, 37, 38, 40, 43, 44], "version": [0, 3, 5, 6, 9, 13, 14, 15, 17, 18, 19, 20, 21, 22, 24, 25, 27, 28, 34, 39, 40, 42], "within": [0, 4, 5, 7, 41], "context": [0, 1, 7, 11, 13, 14, 17, 19, 21, 22, 23, 24, 27, 28, 33, 37, 39, 40, 44], "a5dca4c": 0, "py3": 0, "type": [0, 1, 8, 12, 21, 24, 35, 37], "annot": [0, 24, 37, 38], "c15b23b": 0, "some": [0, 41], "output": [0, 1, 8, 25, 34, 38, 44], "visual": [0, 9, 39, 42], "406f97a": 0, "8f4bedf": 0, "test": [0, 8], "import": 0, "a74342b": 0, "refactor": [0, 1, 8], "creat": [0, 1, 4, 8, 9, 15, 19, 24, 32, 37, 39, 42], "subcommand": [0, 8, 14, 43, 44], "f529d28": 0, "also": [0, 1, 4, 8, 31, 37, 40, 44], "organ": 0, "cli": [0, 8, 9, 39], "ad": [0, 1, 8, 41, 44], "show": [0, 1, 7, 8, 9, 14, 39, 43], "bump": [0, 3, 4, 6, 9, 14, 19, 31, 32, 34, 37, 38, 39, 40, 41, 43], "0bbd814": 0, "possibl": [0, 1, 14, 37, 41], "result": [0, 14, 40, 44], "command": [0, 7, 11, 14, 15, 37, 38, 39, 44], "sampl": [0, 14, 43], "config": [0, 1, 8, 9, 13, 22, 24, 25, 27, 32, 34, 37, 39, 40, 43], "featur": [0, 1, 38], "3d0f67d": 0, "initi": [0, 11, 19, 21, 22, 23, 28, 31, 32, 35], "implement": [0, 1, 11, 24], "document": [0, 8, 44], "4f90348": 0, "46c9c48": 0, "extra": [0, 23, 35, 37], "whitespac": 0, "when": [0, 1, 4, 8, 28, 31, 32, 33, 37, 38, 41, 43], "pyproject": [0, 8, 17, 37, 44], "toml": [0, 3, 4, 8, 17, 22, 40, 43, 44], "839f17f": 0, "remov": [0, 1, 8, 38, 44], "dot": [0, 25, 41], "notat": 0, "from": [0, 3, 8, 14, 16, 19, 24, 25, 27, 32, 33, 37, 40, 41, 43], "requir": [0, 1, 3, 4, 8, 21, 32, 33, 37, 44], "There": [0, 1, 8, 41, 44], "i": [0, 6, 8, 11, 12, 13, 14, 15, 17, 18, 21, 22, 24, 25, 27, 31, 32, 33, 34, 37, 38, 40, 41, 43, 44], "an": [0, 6, 8, 11, 15, 18, 23, 24, 26, 27, 31, 33, 35, 37, 40, 41, 43, 44], "issu": [0, 1, 8], "how": [0, 7, 8, 22, 32, 37], "set": [0, 6, 13, 27, 37, 38, 40, 41], "valu": [0, 1, 6, 8, 12, 13, 14, 15, 17, 18, 19, 21, 22, 23, 25, 27, 31, 32, 33, 35, 38, 43, 44], "tomlkit": [0, 16], "data": [0, 32], "structur": [0, 16], "get_nested_valu": [0, 27], "set_nested_valu": [0, 27], "replac": [0, 4, 5, 7, 14, 18, 19, 22, 28, 38, 39, 43], "pre": [0, 37, 42], "commit": [0, 8, 13, 14, 19, 24, 38, 43, 44], "ci": 0, "autoupd": 0, "ee4d2f3": 0, "github": [0, 1, 4, 6, 8, 12], "com": [0, 1, 4, 8, 12], "astral": 0, "sh": [0, 3], "ruff": 0, "v0": 0, "empti": [0, 21, 33, 37], "string": [0, 3, 8, 12, 19, 23, 27, 28, 30, 33, 34, 35, 37, 38, 41], "bug": [0, 8], "d9965ab": 0, "onli": [0, 3, 8, 12, 14, 22, 24, 25, 27, 31, 37, 38, 40, 43, 44], "trigger": [0, 44], "one": [0, 1, 8, 15, 25, 31, 33, 37, 41, 44], "fallback": 0, "option": [0, 4, 6, 7, 11, 13, 14, 18, 19, 21, 22, 23, 24, 25, 27, 28, 31, 32, 34, 37, 43, 44], "117": 0, "add": [0, 1, 8, 19, 23, 24, 35, 37, 43], "support": [0, 1, 8, 21, 31, 37, 42], "legaci": [0, 8, 12, 18, 37], "multilin": [0, 30, 40], "search": [0, 1, 3, 4, 6, 7, 14, 15, 17, 19, 22, 27, 28, 38, 39, 43], "ref": 0, "98": 0, "278eae5": 0, "2e9a400": 0, "being": 0, "abl": [0, 1, 37, 43], "tag": [0, 8, 13, 14, 15, 19, 21, 24, 27, 38, 43, 44], "without": [0, 7, 8, 27, 38], "753c990": 0, "autom": [0, 1, 42], "19215f1": 0, "The": [0, 3, 6, 8, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 27, 28, 31, 32, 33, 34, 37, 38, 40, 41, 43, 44], "decoupl": 0, "flag": [0, 27, 37, 40, 41], "miscast": 0, "current_vers": [0, 3, 4, 6, 8, 13, 14, 17, 18, 19, 22, 24, 27, 38, 40, 41, 43, 44], "b8ea252": 0, "us": [0, 1, 4, 6, 7, 12, 13, 14, 15, 17, 18, 19, 22, 23, 24, 28, 32, 33, 37, 38, 41, 43, 44], "configur": [0, 1, 4, 6, 7, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 25, 26, 32, 34, 38, 39, 42], "format": [0, 5, 7, 8, 18, 21, 28, 33, 37, 39, 40, 41, 44], "singl": [0, 8, 40, 44], "digit": 0, "pars": [0, 4, 8, 14, 17, 18, 19, 24, 28, 32, 33, 38, 41, 43, 44], "int": [0, 14, 23, 24, 26, 31, 32, 34, 35], "99": 0, "regress": 0, "2bbbd74": 0, "108": 0, "case": [0, 1, 22], "line": [0, 1, 3, 7, 14, 15, 34, 37, 39, 40, 44], "start": [0, 1, 8, 27, 31, 34, 41, 43], "regex": [0, 14, 19, 27, 40, 43], "ef4823c": 0, "workflow": [0, 8, 44], "690452e": 0, "mismatch": 0, "artifact": 0, "up": [0, 1], "download": [0, 8], "3f61742": 0, "pr_number": 0, "retriev": [0, 15, 27], "85a8b48": 0, "12ba54f": 0, "d2f30a8": 0, "pr": 0, "acquisit": 0, "67ab83d": 0, "put": [0, 38], "temporari": 0, "debug": 0, "step": [0, 1], "6ac064": 0, "chang": [0, 1, 3, 4, 6, 8, 13, 14, 18, 19, 22, 24, 37, 38, 40, 41, 43, 44], "caus": 0, "run": [0, 8, 13, 17, 18, 38, 43], "23e6c18": 0, "action": 0, "d96e07a": 0, "default": [0, 1, 3, 6, 8, 15, 16, 25, 27, 31, 37, 38, 40, 41, 42, 44], "none": [0, 8, 11, 12, 13, 14, 15, 17, 18, 19, 21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 34, 35, 44], "93191f3": 0, "64": 0, "fals": [0, 13, 17, 18, 22, 23, 24, 25, 32, 34, 37, 43, 44], "wa": [0, 11, 21, 38], "overrid": [0, 15, 37], "file": [0, 1, 3, 5, 7, 9, 12, 13, 14, 15, 16, 18, 19, 20, 21, 24, 32, 38, 39, 40], "84556f8": 0, "gh": 0, "42bab83": 0, "regard": 0, "multipl": [0, 3, 4, 5, 7, 8, 33, 37, 40, 41], "e7a7629": 0, "method": [0, 1, 13, 17, 22, 25], "mark": 0, "dict": [0, 16, 17, 18, 19, 20, 22, 23, 24, 25, 27, 28, 32, 33, 35], "kei": [0, 15, 17, 18, 21, 25, 27, 32, 33, 44], "name": [0, 4, 8, 11, 19, 24, 25, 26, 32, 37, 38, 41], "list": [0, 1, 8, 11, 12, 13, 14, 19, 20, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 40, 41, 44], "filechang": [0, 19, 20, 22], "encapsul": 0, "log": [0, 1, 22, 23, 24, 26], "provid": [0, 1, 3, 23, 31, 38, 41, 44], "indent": [0, 23, 26, 35], "4e68214": 0, "fileconfig": [0, 22], "249a999": 0, "thi": [0, 1, 3, 4, 6, 8, 11, 18, 22, 23, 25, 28, 31, 32, 37, 40, 43, 44], "better": [0, 1, 8], "describ": [0, 1, 37], "what": [0, 1, 43], "class": [0, 21], "doe": [0, 8, 12, 21, 22, 27], "move": [0, 8], "get_search_pattern": [0, 19], "sinc": [0, 1, 37, 38, 41, 43], "specif": [0, 8, 13, 15, 19, 32], "each": [0, 4, 23, 37, 38, 41, 43], "instanc": 0, "manag": [0, 8, 15, 24, 28, 29, 32, 37], "a4c90b2": 0, "ini": [0, 8, 18, 40], "stuff": 0, "files_legaci": [0, 9, 15, 39], "py": [0, 8, 12, 37], "gener": [0, 1, 6, 8, 13, 23, 27, 31, 32, 37, 43], "upgrad": [0, 8], "121ef69": 0, "cach": [0, 19], "resolv": [0, 19, 20, 22, 25], "filemap": [0, 19], "c96e0bd": 0, "custom": [0, 5, 7, 21], "4ce17a9": 0, "logger": [0, 13, 14, 15, 17, 18, 19, 22, 23, 24, 26, 28, 33], "improv": 0, "consol": [0, 26, 44], "d1d19e3": 0, "909396d": 0, "ar": [0, 1, 4, 8, 12, 14, 20, 21, 32, 33, 34, 37, 38, 40, 41, 44], "hashabl": 0, "weed": 0, "out": [0, 1], "duplic": 0, "comment": [0, 1], "89686b8": 0, "extract_regex_flag": [0, 27], "a980670": 0, "cae12dc": 0, "e218264": 0, "74": 0, "tag_nam": [0, 14, 19, 24, 43], "now": [0, 4, 38, 43], "do": [0, 4, 37, 44], "need": [0, 1, 8, 37], "match": [0, 3, 20, 22, 33, 37, 40], "exactli": 0, "logic": [0, 40], "auto": 0, "909a53f": 0, "http": [0, 1, 8, 12, 33, 41], "callowayproject": [0, 1, 8], "my": [0, 3, 4, 9, 14, 19, 34, 37, 38, 40, 41, 43, 44], "85": 0, "97049e0": 0, "hg": [0, 24], "return": [0, 11, 12, 13, 15, 16, 17, 18, 19, 20, 22, 23, 24, 25, 27, 28, 30, 31, 32, 33, 34, 35, 41], "order": [0, 8, 28, 32, 37], "thei": [0, 1, 28, 37, 38], "were": [0, 8, 11], "so": [0, 6, 8, 11, 23, 37, 40], "we": [0, 1, 6, 8, 21, 25, 37, 41, 43, 44], "want": [0, 1, 8, 14, 37, 38, 43, 44], "last": [0, 37, 43], "autovers": 0, "a308a35": 0, "key_path": [0, 19], "e160b40": 0, "made": [0, 22], "all": [0, 1, 4, 8, 20, 21, 24, 33, 37, 41, 44], "attribut": [0, 25], "except": [0, 9, 31, 39, 44], "filenam": [0, 3, 4, 6, 19, 40], "glob": [0, 19, 20], "hook": [0, 37], "8188a42": 0, "more": [0, 1, 8, 19, 32, 41, 44], "inform": [0, 1, 7, 8, 14, 18, 23, 24, 25, 37], "see": [0, 1, 8, 21, 43], "4c81ad4": 0, "7109d70": 0, "e407974": 0, "re": [0, 1, 18, 19, 22], "written": 0, "avoid": [0, 5, 7, 8, 18, 35], "wrong": [0, 3, 21], "It": [0, 1, 6, 8, 31, 37, 44], "two": [0, 8, 33, 37, 41, 44], "wai": [0, 1, 8, 22, 44], "parser": [0, 12, 40], "maintain": [0, 1, 4, 8, 41], "old": [0, 40], "deprec": [0, 8], "8769671": 0, "dev": [0, 1, 30, 43], "number": [0, 4, 8, 15, 21, 22, 23, 31, 32, 37, 38, 41, 42], "463082b": 0, "1eed99b": 0, "echo": [0, 26], "develop": [0, 1, 7, 41, 43], "e89599f": 0, "5ebb0d7": 0, "65": 0, "where": [0, 8, 37], "d": [0, 4, 27, 37, 38, 40, 43], "weren": 0, "t": [0, 1, 4, 8, 13, 15, 22, 33, 37], "357b9dc": 0, "h": [0, 8], "help": [0, 1, 8, 21, 41], "fda71b0": 0, "67": 0, "drop": [0, 8, 37], "python3": 0, "compat": [0, 8, 44], "890edc8": 0, "longer": [0, 8, 37], "": [0, 1, 3, 8, 12, 14, 22, 32, 33, 37, 40, 41, 44], "safer": 0, "fbcef03": 0, "recommend": [0, 1, 8, 37, 44], "call": [0, 11, 41], "instead": [0, 1, 3, 8, 18, 19, 22, 32, 40, 41], "bumpvers": [0, 3, 4, 6, 7, 8, 37, 39, 40, 41, 43, 44], "9fb1a1d": 0, "e2579d6": 0, "290": 0, "292": 0, "e21fdd9": 0, "7e5d1bc": 0, "non": [0, 37, 38, 41], "0034716": 0, "59": 0, "doc": [0, 33], "4a3d046": 0, "285": 0, "script": [0, 1, 7], "a59ced8": 0, "depend": [0, 1, 28, 32, 35, 37, 41], "pydant": [0, 8, 19, 32], "577aa4c": 0, "resolut": [0, 25], "inclus": 0, "exclus": [0, 37], "646af54": 0, "61": 0, "includ": [0, 1, 3, 4, 6, 8, 13, 14, 20, 38, 41, 44], "resolved_filemap": [0, 19], "properti": [0, 19, 23, 28, 32], "exapand": 0, "files_to_modifi": [0, 19], "modifi": [0, 1, 8, 14, 19, 22, 25, 37, 44], "exclut": 0, "add_fil": [0, 19], "c1ef3b2": 0, "55": 0, "ignor": [0, 1, 37], "falsei": 0, "construct": 0, "cd71a1a": 0, "doubl": [0, 40], "backslash": [0, 40], "while": [0, 4, 37, 40, 41], "doesn": [0, 4, 22, 33], "7856ee0": 0, "build": [0, 37, 41], "48980d7": 0, "7c38c40": 0, "284": 0, "c30bd12": 0, "282": 0, "95c89fb": 0, "281": 0, "mention": [0, 1], "python": [0, 1, 8, 12, 14, 33, 37, 38, 40, 44], "a91f690": 0, "130bbe0": 0, "reset": [0, 23, 32, 37, 41], "befor": [0, 6, 8, 22, 37, 38, 43], "4b457d0": 0, "adb7e4c": 0, "277": 0, "pygments_styl": 0, "docsrc": 0, "conf": 0, "32798a9": 0, "theme": 0, "subject": 0, "look": [0, 1, 8, 37, 40], "about": [0, 1, 24, 25], "regular": [0, 18, 33, 37, 38, 41, 43], "express": [0, 18, 22, 33, 37, 38, 41, 43], "449b70a": 0, "no_regex": 0, "a295a32": 0, "global": 0, "individu": [0, 1, 37], "avail": [0, 1, 8, 37, 38, 40, 44], "sub": [0, 8, 44], "abil": 0, "0210d74": 0, "treat": [0, 37, 40], "after": [0, 22, 31, 37, 38], "substitut": 0, "warn": [0, 8, 26], "cfg": [0, 8, 17, 37], "a0481b7": 0, "e0731c3": 0, "a5bd008": 0, "45c85be": 0, "can": [0, 1, 4, 8, 13, 15, 23, 37, 38, 40, 41, 43, 44], "733438b": 0, "go": [0, 4], "bye": 0, "subcomand": 0, "leav": [0, 1], "781e8d8": 0, "complet": [0, 1, 28, 44], "ani": [0, 1, 8, 11, 12, 14, 15, 17, 18, 19, 22, 23, 25, 27, 28, 32, 35, 44], "34": 0, "531738d": 0, "276": 0, "61e6747": 0, "charliermarsh": 0, "coverag": 0, "3fe96f0": 0, "pin": 0, "d4b125e": 0, "bfe5306": 0, "declar": 0, "sourcecodemanag": [0, 24], "classvar": [0, 24], "str": [0, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 31, 32, 33, 34, 35], "_test_usable_command": [0, 24], "_commit_command": [0, 24], "_all_tags_command": [0, 24], "affect": 0, "a53cddc": 0, "c62d65e": 0, "8722a0f": 0, "work": [0, 1, 8, 21, 24, 37, 44], "just": [0, 1, 8, 18, 25, 31], "like": [0, 1, 8, 18, 23, 28, 37, 40], "increment": [0, 7, 14, 25, 37], "Will": [0, 8], "new_vers": [0, 3, 4, 6, 8, 13, 14, 17, 18, 22, 24, 25, 27, 37, 38, 40, 43, 44], "versionpart": [0, 44], "would": [0, 1, 3, 11, 22, 38, 41], "short_branch_nam": [0, 24, 38], "render": [0, 13, 19, 22, 27, 28, 33, 34, 37, 38, 40, 41], "7f7e50c": 0, "branch": [0, 38], "lower": 0, "contain": [0, 3, 4, 14, 17, 20, 22, 23, 27, 33, 40, 44], "z": [0, 43], "truncat": [0, 38], "charact": [0, 23, 34, 41], "28": 0, "3a6e3e": 0, "part": [0, 7, 13, 14, 19, 20, 21, 22, 28, 29, 31, 32, 33, 34, 38, 39, 43, 44], "ee43bdb": 0, "5e6f566": 0, "f1acd35": 0, "272": 0, "275": 0, "invoc": [0, 8, 44], "9d965e5": 0, "8960d24": 0, "tomldocu": [0, 16], "unwrap": 0, "convert": [0, 8, 12, 38], "branch_nam": [0, 24, 38], "173be1a": 0, "d537274": 0, "b01fffc": 0, "specifi": [0, 8, 14, 15, 21, 31, 32, 37, 41, 44], "9bce887": 0, "supersed": 0, "much": [0, 1], "capabl": 0, "yaml": [0, 1, 4, 25, 35, 44], "json": [0, 25, 44], "item": [0, 25, 31, 44], "displai": [0, 25], "pull": 0, "nest": [0, 27], "31ffbcf": 0, "backward": [0, 8, 44], "previou": [0, 1, 6, 8, 34, 37, 44], "forward": [0, 1], "problem": [0, 1], "click": [0, 8, 11, 14, 21], "automat": [0, 8, 12, 43], "must": [0, 1, 3, 4, 6, 37, 40, 43], "report": [0, 8, 22], "efb04e9": 0, "correct": [0, 8, 12, 34], "5476cdf": 0, "6e500c2": 0, "270": 0, "complaint": 0, "subprocess": 0, "c429c68": 0, "da7544f": 0, "underli": 0, "edg": 0, "deriv": 0, "environ": [0, 1, 8, 27, 37, 44], "variabl": [0, 8, 12, 15, 25, 37, 44], "multpl": 0, "fail": [0, 1, 37], "reproduc": [0, 1], "d78ff46": 0, "893ec03": 0, "version_part": [0, 9, 13, 14, 19, 22, 25, 39], "f236b7d": 0, "detect": [0, 12], "argument": [0, 8, 19, 23, 32, 37], "base": [0, 1, 11, 12, 15, 19, 21, 23, 24, 27, 31, 32, 34, 35], "indic": [0, 37, 38, 41], "22edeac": 0, "23be62d": 0, "rais": [0, 12, 13, 15, 19, 22, 24, 25, 26, 27, 32, 33], "1e3ebc5": 0, "valueerror": [0, 12, 27, 31], "badargumentusag": 0, "readm": [0, 1], "7780265": 0, "releas": [0, 4, 8, 37, 40, 42, 44], "01870d5": 0, "note": [0, 8], "266002f": 0, "edc444f": 0, "261": 0, "3d5c253": 0, "instal": [0, 7], "c1034eb": 0, "spec": [0, 33], "4782745": 0, "pypi": [0, 8], "e5ed27d": 0, "d4b03d7": 0, "vagu": 0, "info": [0, 24], "4fb5158": 0, "If": [0, 1, 3, 8, 11, 12, 13, 14, 15, 17, 24, 25, 27, 33, 34, 37, 38, 40, 41, 43, 44], "disabl": [0, 37], "packag": [0, 8, 37], "7c12072": 0, "inspect": 0, "didn": 0, "save": 0, "dist": 0, "f8f0278": 0, "path": [0, 13, 15, 16, 17, 18, 19, 22, 24, 27, 42], "restrict": 0, "hint": 0, "e1af658": 0, "8738f3f": 0, "tabl": [0, 37], "content": 0, "49858c0": 0, "migrat": 0, "setuptool": 0, "f10f8b2": 0, "d626f7d": 0, "black": 0, "psf": 0, "ac6cdd0": 0, "serial": [0, 4, 9, 14, 17, 18, 19, 28, 29, 38, 39, 41, 43, 44], "c529452": 0, "get": [0, 8, 16, 25, 26, 31, 40], "8006f3e": 0, "scminfo": [0, 19, 24, 27], "setup": [0, 8, 17, 37], "e8fddc9": 0, "xml": [0, 37], "696503f": 0, "assert": [0, 24], "7afe58c": 0, "equal": [0, 31, 33], "64b0de3": 0, "same": [0, 1, 5, 7, 22, 34, 37, 41], "exit": [0, 8, 26], "c025650": 0, "exist": [0, 1, 11, 13, 16, 17, 22, 27], "tool": [0, 1, 3, 4, 6, 8, 13, 24, 37, 40, 41, 43], "19f13b7": 0, "pat": 0, "pipelin": 0, "hopefulli": 0, "allow": [0, 8, 19, 21, 23, 32, 37, 43, 44], "master": [0, 12], "codecov": 0, "a5009e0": 0, "metadata": 0, "0bd54dc": 0, "1b1d910": 0, "6c3b4fe": 0, "allow_dirti": [0, 14, 19, 43], "b042e31": 0, "git": [0, 1, 8, 24, 37, 38], "2a977af": 0, "quot": [0, 3], "9a55d6d": 0, "window": [0, 1], "b8abc44": 0, "cast": [0, 12], "them": [0, 1, 3, 31, 40, 41], "pathlib": [0, 13, 15, 17, 18, 19, 24], "556853b": 0, "seem": [0, 1, 28], "ddfd3bf": 0, "fbf85c2": 0, "stop": [0, 1], "find": [0, 1, 3, 8, 11, 15, 17, 37, 40], "header": [0, 37], "0aea9dc": 0, "addit": [0, 8, 14, 38, 44], "manual": 0, "verbos": [0, 8, 14, 26, 43], "81eb097": 0, "a9cac5b": 0, "increas": [0, 8, 14, 23, 31, 32, 43, 44], "close": 0, "relas": 0, "upload": 0, "thing": [0, 44], "pythonutf8": 0, "mode": [0, 8, 44], "91a73e2": 0, "org": [0, 33, 41], "html": [0, 33], "utf": 0, "explicit": [0, 13, 15, 17, 37], "80fe7ef": 0, "2b3b358": 0, "cfbba08": 0, "main": [0, 8, 10], "alias": [0, 9, 39], "licens": [0, 1, 7], "34a9be5": 0, "71a204b": 0, "utf8": 0, "9cb8f60": 0, "fe794dd": 0, "function": [0, 1, 8, 9, 29, 39, 44], "88709fd": 0, "19eaeef": 0, "d339007": 0, "convers": 0, "f5d1cab": 0, "d7dec79": 0, "857835d": 0, "dispatch": 0, "input": [0, 1, 16, 19, 21, 32], "f3b7a0f": 0, "renam": [0, 1], "tox": 0, "job": [0, 22], "a9b6db3": 0, "e0cebb3": 0, "mercuri": [0, 8, 24, 37, 38], "560999d": 0, "6ccfa7d": 0, "subclass": [0, 11], "usageerror": [0, 21], "a447651": 0, "basevc": 0, "11c5609": 0, "consist": [0, 41], "group": [0, 8, 11, 31, 37, 41], "back": [0, 37], "6d4179b": 0, "eventu": 0, "later": 0, "creation": 0, "off": 1, "thank": [1, 8], "take": 1, "time": [1, 37], "encourag": 1, "detail": [1, 8], "handl": [1, 8, 11, 18, 22], "pleas": [1, 8], "make": [1, 6, 8, 11, 19, 20, 22], "sure": [1, 11, 20], "read": [1, 8, 17, 32], "relev": 1, "section": [1, 6, 17, 18, 37, 43], "easier": [1, 8], "u": [1, 37, 40], "smooth": 1, "experi": 1, "involv": 1, "commun": 1, "you": [1, 4, 6, 8, 14, 23, 31, 37, 38, 40, 41, 43, 44], "don": [1, 8, 37], "fine": 1, "other": [1, 8, 28, 32, 37, 41], "easi": [1, 23], "appreci": 1, "which": [1, 23, 31, 37, 41], "veri": [1, 8], "happi": 1, "star": 1, "tweet": 1, "refer": [1, 7, 37, 38], "local": [1, 30, 38], "meetup": 1, "tell": 1, "friend": 1, "colleagu": 1, "everyon": 1, "particip": 1, "govern": 1, "By": [1, 8, 37, 41], "expect": 1, "uphold": 1, "unaccept": 1, "behavior": [1, 37], "coreyoordt": 1, "gmail": 1, "ask": [1, 44], "assum": 1, "best": [1, 8], "might": [1, 27, 37, 38, 41], "In": [1, 3, 4, 6, 37, 41], "found": [1, 21, 31, 33, 37], "suitabl": 1, "still": [1, 37], "clarif": 1, "write": [1, 8, 18, 22], "advis": 1, "internet": 1, "answer": 1, "feel": 1, "follow": [1, 3, 8, 11, 14, 23, 31, 38, 40, 41, 44], "open": [1, 8], "platform": 1, "nodej": 1, "npm": 1, "etc": 1, "care": 1, "soon": [1, 4], "A": [1, 8, 13, 17, 18, 19, 20, 21, 22, 23, 24, 25, 27, 28, 33, 34, 35, 37, 38, 41], "shouldn": 1, "chase": 1, "therefor": 1, "investig": 1, "carefulli": 1, "collect": [1, 27, 35], "advanc": 1, "fix": 1, "potenti": [1, 43], "fast": 1, "latest": [1, 8, 24, 38], "determin": [1, 12, 32], "realli": 1, "side": 1, "e": [1, 4, 8, 14, 21, 31, 37, 40, 41, 44], "g": [1, 4, 8, 14, 21, 31, 41, 44], "incompat": 1, "compon": [1, 32, 33, 37], "To": [1, 6, 7, 37], "user": [1, 16, 21, 26, 38], "experienc": 1, "alreadi": [1, 31, 43], "solv": 1, "tracker": 1, "stack": [1, 23], "overflow": 1, "outsid": 1, "discuss": 1, "trace": 1, "traceback": 1, "o": 1, "linux": 1, "maco": 1, "x86": 1, "arm": 1, "possibli": 1, "reliabl": 1, "And": 1, "older": 1, "never": 1, "secur": 1, "relat": 1, "vulner": 1, "sensit": 1, "elsewher": 1, "public": 1, "sent": 1, "email": 1, "track": 1, "point": [1, 8, 34], "whether": [1, 37], "talk": 1, "yet": 1, "label": [1, 27, 28, 33, 34, 43], "explain": 1, "actual": [1, 37], "reproduct": 1, "someon": 1, "els": 1, "recreat": 1, "own": 1, "usual": 1, "For": [1, 8, 37, 38, 40, 41, 44], "should": [1, 8, 13, 16, 17, 18, 22, 23, 28, 37], "isol": 1, "reduc": 1, "onc": [1, 8], "accordingli": 1, "member": 1, "try": [1, 31, 37], "obviou": 1, "those": [1, 8, 14, 33, 37, 44], "address": 1, "until": [1, 41], "left": [1, 34], "guid": [1, 7], "through": [1, 31, 37], "new": [1, 8, 13, 16, 17, 18, 19, 25, 32, 37, 38, 40, 42, 44], "minor": [1, 4, 8, 14, 30, 37, 38, 40, 41, 43, 44], "guidelin": 1, "understand": 1, "cover": 1, "mayb": 1, "perform": 1, "ha": [1, 4, 6, 31, 38, 41, 43], "been": 1, "idea": [1, 18, 28], "fit": [1, 34], "scope": 1, "aim": 1, "strong": 1, "convinc": 1, "merit": 1, "keep": 1, "mind": 1, "major": [1, 4, 8, 30, 37, 38, 41, 43, 44], "our": [1, 8], "small": [1, 8], "subset": 1, "target": 1, "consid": [1, 31, 37, 41], "plugin": 1, "librari": 1, "clear": 1, "descript": [1, 37], "titl": 1, "identifi": 1, "benefit": 1, "why": 1, "most": [1, 8, 28], "mai": [1, 3, 8, 14, 31, 37, 41, 44], "could": 1, "serv": 1, "inspir": 1, "mani": 1, "altern": [1, 40], "appropri": 1, "legal": 1, "notic": 1, "agre": 1, "author": 1, "100": 1, "necessari": 1, "right": [1, 34], "under": [1, 8], "sever": [1, 6, 17], "termin": 1, "clone": 1, "repositori": [1, 38], "enter": 1, "cd": 1, "activ": 1, "virtual": 1, "m": [1, 38], "venv": 1, "env": [1, 15], "sourc": [1, 8, 11, 12, 13, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35, 37], "bin": 1, "pip": [1, 8], "r": [1, 40], "txt": [1, 3, 8, 37, 44], "pytest": 1, "everi": [1, 8, 38], "here": [1, 8, 37], "basic": [1, 12, 40], "process": [1, 23, 34, 37, 40, 44], "categor": 1, "exampl": [1, 4, 6, 7, 8, 11, 23, 34, 38, 40, 41, 42, 44], "cool": 1, "updat": [1, 8, 13, 16, 17, 18, 22, 37], "delet": 1, "refacto": 1, "chg": 1, "modif": 1, "taxonomi": 1, "schema": 1, "419": 1, "123": 1, "summari": 1, "cosmet": 1, "wip": 1, "reach": 1, "gen": 1, "have": [3, 4, 6, 8, 37, 38, 41], "given": [3, 8, 11, 14, 24, 27, 28, 32, 33, 44], "myproject": [3, 4, 40], "django": [3, 25], "1": [3, 4, 8, 9, 23, 34, 37, 40, 41, 43, 44], "5": [3, 8, 44], "6": [3, 8, 44], "templat": [3, 24, 25, 37], "text": [3, 8, 40], "0": [3, 8, 9, 24, 25, 26, 31, 34, 37, 41, 43, 44], "ensur": [3, 38], "liter": [3, 38, 40], "pattern": [3, 19, 20, 22, 27, 33, 37, 40, 41], "my_vers": 3, "2": [3, 4, 8, 23, 37, 40, 41, 43, 44], "3": [3, 8, 33, 40, 43], "Then": 3, "even": 4, "modul": [4, 7, 10, 29], "awar": 4, "project": [4, 8, 14, 32, 41, 44], "your": [4, 8, 14, 37, 38, 40], "beyond": 4, "v1": [4, 23], "myorg": 4, "v2": [4, 8, 23], "howev": [4, 40], "channel": 4, "mod": 4, "12": 4, "stabl": [4, 41], "21": 4, "4": [4, 40, 41, 43], "p": [4, 37, 41, 43], "v": [4, 8, 37, 43], "patch": [4, 8, 30, 37, 38, 41, 43], "As": 4, "direct": [4, 7], "v3": 4, "incorrect": [5, 7], "changelog": [6, 7, 37], "unreleas": [6, 37, 40], "head": [6, 37], "link": 6, "entri": [6, 37], "unnecessari": 6, "anoth": 6, "its": [6, 17, 32, 37, 41], "md": [6, 8, 37], "introduct": 7, "overview": 7, "futur": [7, 37], "usag": 7, "contribut": 7, "tutori": 7, "semant": [7, 41, 42], "interfac": [7, 8, 14, 26, 39], "explan": 7, "index": [7, 8, 25], "page": 7, "bump2vers": 8, "fork": 8, "excel": 8, "goal": 8, "rich": 8, "valid": [8, 14, 19, 32, 33, 40, 44], "code": [8, 24, 37], "softwar": [8, 32, 37], "simplifi": [8, 43], "highli": 8, "happili": 8, "program": 8, "languag": 8, "8": [8, 37], "pypy3": 8, "switch": [8, 43], "both": [8, 37, 40, 41], "truli": 8, "alwai": [8, 40, 43], "ui": [8, 9, 39], "throughout": [8, 44], "interchang": [8, 44], "oper": [8, 13, 44], "On": [8, 44], "complex": [8, 33, 44], "multi": [8, 44], "split": [8, 44], "remain": [8, 44], "discourag": [8, 44], "defin": [8, 38, 41], "These": [8, 37, 38], "rewrit": [8, 14, 44], "9": [8, 37, 41, 43, 44], "four": [8, 37], "place": [8, 37, 41], "preced": [8, 37, 41], "bumpversion_config_fil": [8, 37], "due": 8, "style": 8, "system": [8, 24, 37], "greater": [8, 37], "flexibl": [8, 37], "abov": [8, 41], "addition": 8, "dry": [8, 13, 17, 18], "n": [8, 24, 40], "touch": 8, "pretend": 8, "similar": 8, "print": [8, 14], "stderr": 8, "than": [8, 44], "machin": 8, "readabl": 8, "stdout": [8, 16], "consumpt": 8, "18": 8, "19": 8, "sai": 8, "flow": 8, "know": [8, 41], "appli": 8, "standard": [8, 30], "bash": 8, "becom": [8, 38], "contributor": 8, "graph": 8, "happen": 8, "welcom": 8, "well": 8, "aspect": 8, "intend": 8, "versatil": 8, "mit": 8, "top": [9, 34], "level": [9, 23], "util": [9, 11, 15, 24, 26, 39], "model": [9, 13, 15, 17, 20, 22, 27, 28, 29, 30, 33, 39], "convent": [9, 29, 39], "yaml_dump": [9, 39], "autocast": [9, 39], "indented_logg": [9, 26, 39], "__main__": [9, 39], "__version__": 9, "17": [9, 40], "entrypoint": 10, "aliasedgroup": 11, "accept": 11, "prefix": [11, 38], "arg": [11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 22, 23, 24, 25, 27, 28, 32, 33, 34, 37, 44], "kwarg": [11, 23, 27, 35], "rich_click": 11, "rich_group": 11, "richgroup": 11, "push": [11, 37], "pu": 11, "alia": 11, "long": 11, "uniqu": [11, 37], "get_command": 11, "ctx": [11, 13, 14, 21], "cmd_name": 11, "object": [11, 23, 25, 28, 33, 38], "resolve_command": 11, "tupl": [11, 16, 19, 23, 27, 28, 33, 35], "true": [12, 13, 16, 17, 18, 22, 23, 24, 25, 34, 37, 40, 41], "cgreer": 12, "cgautocast": 12, "blob": 12, "boolifi": 12, "boolean": [12, 37, 38], "noneifi": 12, "listifi": 12, "represent": [12, 28, 35], "homogen": 12, "autocast_valu": 12, "guess": 12, "bool": [12, 13, 14, 16, 17, 18, 19, 22, 23, 24, 25, 28, 31, 32, 34, 35], "element": [12, 27, 41], "via": [12, 15, 37], "first": [12, 19, 28, 31, 32, 33, 34, 37], "success": 12, "repres": [12, 21, 27, 28, 32, 37, 38], "typeerror": 12, "var": [12, 37, 38], "get_next_vers": 13, "next": [13, 22, 34, 41, 43], "do_bump": 13, "commit_and_tag": 13, "get_indented_logg": [13, 14, 15, 17, 18, 19, 22, 24, 26, 28, 33], "configurationerror": [13, 15, 21], "config_fil": [13, 14, 15, 17, 18], "dry_run": [13, 14, 17, 18, 22, 24], "configured_fil": 13, "configuredfil": [13, 22], "chainmap": [13, 27], "messag": [13, 14, 19, 21, 23, 24, 26, 27, 38, 43], "sample_config": 14, "show_bump": 14, "core": 14, "no_configured_fil": 14, "ignore_missing_vers": [14, 19, 43], "sign_tag": [14, 19, 43], "tag_messag": [14, 19, 43], "commit_arg": [14, 19, 43], "show_list": 14, "format_": [14, 25], "prompt": [14, 16, 43], "destin": [14, 16, 43], "ascii": 14, "get_configur": 15, "check_current_vers": 15, "union": [15, 17, 18, 19, 24, 31, 32, 35], "otherwis": [15, 24, 31, 40], "attempt": [15, 33, 40], "dictionari": [15, 17, 18, 27, 33], "create_configur": 16, "get_defaults_from_dest": 16, "find_config_fil": 17, "read_config_fil": 17, "read_toml_fil": 17, "update_config_fil": 17, "config_file_search_ord": 17, "explicit_fil": 17, "pass": [17, 23, 37], "explicitli": [17, 18, 37], "file_path": [17, 18, 22], "mutablemap": [17, 19, 22, 23, 24, 28, 33], "read_ini_fil": 18, "update_ini_config_fil": 18, "unintent": 18, "basemodel": [19, 32], "keyword": [19, 23, 32, 37], "validationerror": [19, 32], "pydantic_cor": [19, 32], "cannot": [19, 25, 32, 43], "form": [19, 32], "__init__": [19, 32, 37], "__pydantic_self__": [19, 32], "common": [19, 32], "self": [19, 21, 32], "field": [19, 32, 37, 40], "__hash__": 19, "hash": [19, 38], "compil": [19, 22, 31, 40], "raw": [19, 22], "_case_sensit": 19, "_env_prefix": 19, "_env_fil": 19, "pydantic_set": 19, "dotenvtyp": 19, "env_file_sentinel": 19, "_env_file_encod": 19, "_env_nested_delimit": 19, "_secrets_dir": 19, "baseset": 19, "scm_info": [19, 27], "versioncomponentconfig": [19, 20, 22, 28, 32], "included_path": 19, "excluded_path": 19, "model_config": 19, "settingsconfigdict": 19, "_resolved_filemap": 19, "_resolve_filemap": 19, "map": [19, 25], "expand": 19, "version_config": [19, 22], "versionconfig": [19, 22, 28], "version_spec": [19, 32], "versionspec": [19, 30, 32], "helper": 20, "get_all_file_config": 20, "get_all_part_config": 20, "resolve_glob_fil": 20, "config_dict": 20, "file_cfg": 20, "accord": [20, 22], "bumpversionerror": [21, 33], "accur": 21, "signatur": [21, 23], "formattingerror": [21, 33], "unabl": 21, "missingvalueerror": 21, "dirtyworkingdirectoryerror": 21, "directori": [21, 24, 37], "dirti": [21, 24, 37, 38], "signedtagserror": [21, 24], "vc": [21, 24], "sign": [21, 24, 37], "versionnotfounderror": [21, 22], "invalidversionparterror": 21, "bugfix": 21, "badinputerror": [21, 25], "fileupdat": 22, "datafileupdat": 22, "contains_pattern": 22, "log_chang": 22, "resolve_file_config": 22, "modify_fil": 22, "file_content_befor": 22, "file_content_aft": 22, "file_chang": 22, "get_file_cont": 22, "filenotfounderror": 22, "write_file_cont": 22, "_contains_change_pattern": 22, "search_express": 22, "raw_search_express": 22, "origin": [22, 32], "isn": 22, "present": [22, 37], "fact": 22, "make_file_chang": 22, "__str__": [22, 24], "__repr__": [22, 24, 28, 32], "update_fil": 22, "version_part_config": 22, "_update_toml_fil": 22, "search_for": 22, "raw_search_pattern": 22, "replace_with": 22, "adapt": 23, "begin": [23, 37], "indentedloggeradapt": [23, 26], "current_ind": 23, "contextvar": 23, "depth": 23, "indent_char": 23, "loggeradapt": 23, "paramet": 23, "zero": 23, "contextu": 23, "constructor": 23, "desir": 23, "effect": 23, "shown": 23, "somelogg": 23, "p1": 23, "p2": 23, "amount": [23, 34], "dedent": 23, "decreas": 23, "indent_str": 23, "msg": [23, 26], "control": 24, "state": 24, "get_scm_info": 24, "commit_sha": [24, 38], "distance_to_latest_tag": [24, 38, 43], "classmethod": 24, "extra_arg": 24, "is_us": 24, "usabl": 24, "abstract": [24, 31], "assert_nondirti": 24, "latest_tag_info": 24, "parse_pattern": [24, 33], "add_path": 24, "get_all_tag": 24, "get_version_from_tag": 24, "commit_to_scm": 24, "tag_in_scm": 24, "rev": 24, "dir": 24, "f": 24, "lightweight": [24, 37], "root": 24, "logfil": 24, "clean": 24, "output_default": 25, "output_yaml": 25, "output_json": 25, "resolve_nam": 25, "attr": 25, "obj": 25, "log_list": 25, "do_show": 25, "outputt": 25, "err_on_miss": 25, "copi": [25, 32], "lookup": 25, "sequenc": [25, 31, 41], "access": 25, "mykei": 25, "noqa": 25, "dar401": 25, "setup_log": 26, "print_info": 26, "print_error": 26, "print_warn": 26, "getlogg": 26, "extract": [27, 43], "recursive_sort_dict": 27, "sort": [27, 33], "recurs": 27, "key_val_str": 27, "comma": 27, "delimit": 27, "prefixed_environ": 27, "wrap": 27, "labels_for_format": 27, "serialize_format": 27, "base_context": 27, "get_context": 27, "get_overrid": 27, "overridden": 27, "regex_pattern": 27, "input_valu": 27, "separ": [27, 41], "period": 27, "keyerror": 27, "intern": [28, 29, 37], "hold": 28, "part_config": 28, "__eq__": [28, 32], "good": [28, 43], "becaus": [28, 41, 43], "version_str": [28, 33, 34], "pep440_version_spec": 30, "pep": 30, "440": 30, "semver_spec": 30, "semver": [30, 41], "pep440_pattern": 30, "pep440_serialize_pattern": 30, "pep440_component_config": 30, "semver_pattern": 30, "semver_serialize_pattern": 30, "semver_component_config": 30, "pre_l": [30, 43], "pre_n": [30, 41, 42], "post": 30, "buildmetadata": 30, "partfunct": [31, 32], "independentfunct": 31, "independ": [31, 32], "numericfunct": 31, "numer": [31, 37, 41], "valuesfunct": 31, "first_valu": [31, 32, 41], "optional_valu": [31, 32, 41, 43], "simpli": 31, "integ": [31, 41], "alphanumer": [31, 38], "alter": [31, 37, 43], "r3": 31, "r4": 31, "001": 31, "first_numer": 31, "iter": [31, 37], "maximum": [31, 43], "versioncompon": 32, "relationship": 32, "rule": 32, "behav": 32, "null": 32, "is_opt": 32, "is_independ": 32, "__format__": 32, "format_spec": 32, "depends_on": 32, "create_compon": 32, "create_vers": 32, "get_depend": 32, "component_nam": 32, "__getitem__": 32, "__len__": 32, "__iter__": 32, "required_compon": 32, "deseri": 33, "parse_vers": 33, "multisort": 33, "x": [33, 41, 43], "howto": 33, "stabil": 33, "revers": 33, "pair": 33, "serialize_pattern": 33, "prefer": 33, "shortest": 33, "short": 33, "syntax": [33, 37, 40], "border": 34, "definit": 34, "lead_str": 34, "space": 34, "connection_str": 34, "connect": 34, "labeled_lin": 34, "pad": 34, "filter_version_part": 34, "box_char": 34, "corner_bottom_right": 34, "corner_top_right": 34, "corner_top_left": 34, "corner_bottom_left": 34, "divider_left": 34, "divider_up": 34, "divider_down": 34, "divider_right": 34, "pipe": 34, "cross": 34, "blank": 34, "light": 34, "draw": 34, "length": 34, "has_next": 34, "has_previ": 34, "bottom": 34, "fit_length": 34, "lead": 34, "trail": 34, "against": 34, "box_styl": 34, "simpl": [35, 40], "dumper": 35, "yamldump": 35, "registri": 35, "dump": 35, "buffer": 35, "format_str": 35, "format_int": 35, "format_float": 35, "float": 35, "format_bool": 35, "format_dict": 35, "format_sequ": 35, "format_non": 35, "format_d": 35, "date": [35, 40], "format_datetim": 35, "dumperfunc": 35, "userdict": 35, "add_dump": 35, "data_typ": 35, "val": 35, "_": 35, "datetim": [35, 38], "three": [37, 41], "respectfulli": 37, "No": 37, "anyth": 37, "uncommit": 37, "bumpversion_allow_dirti": 37, "abort": 37, "protect": 37, "unvers": 37, "overwrit": 37, "unsav": 37, "bumpversion_commit": 37, "verifi": 37, "bumpversion_messag": 37, "bumpversion_commit_arg": 37, "bumpversion_tag": 37, "forget": 37, "done": 37, "bumpversion_sign_tag": 37, "bumpversion_tag_nam": 37, "bumpversion_tag_messag": 37, "ye": 37, "bumpversion_current_vers": 37, "bumpversion_pars": 37, "produc": 37, "belong": 37, "arrai": 37, "bumpversion_seri": 37, "choos": 37, "bumpversion_search": 37, "span": 37, "remotest": 37, "mean": 37, "occurr": 37, "bumpversion_replac": 37, "bumpversion_ignore_missing_vers": 37, "partnam": 37, "deviat": 37, "final": [37, 43], "Its": 37, "alpha": [37, 41], "beta": [37, 41], "gamma": 37, "newli": 37, "Their": 37, "directli": 37, "wildcard": 37, "pom": 37, "certain": 37, "append": 37, "between": 37, "paren": 37, "special": [37, 43], "coolapp": 37, "twice": 37, "mutual": 37, "octothorp": 38, "semicolon": 38, "zone": 38, "utcnow": 38, "utc": 38, "guidanc": 38, "colon": 38, "y": 38, "2023": [38, 40], "04": 38, "20": 38, "pend": 38, "lowercas": 38, "long_branch": 38, "featuremylongbranchn": 38, "current_": 38, "current_major": 38, "current_minor": 38, "current_patch": 38, "new_": 38, "new_major": 38, "new_minor": 38, "new_patch": 38, "runtim": 38, "execut": 38, "export": [38, 44], "combin": 40, "escap": 40, "unescap": 40, "enclos": 40, "curli": 40, "brace": 40, "nversion": 40, "unless": 40, "07": 40, "l": 40, "variou": 41, "typic": 41, "recent": 41, "omit": 41, "second": 41, "finish": 41, "release_nam": 41, "witti": 41, "warthog": 41, "ridicul": 41, "rat": 41, "marvel": 41, "manti": 41, "stage": 41, "pre_label": 41, "again": 41, "devopedia": 41, "calver": 41, "cat": 43, "extend": 43, "dash": 43, "seper": 43, "za": 43, "rc": 43, "dev0": 43, "invalid": 43, "among": 43, "final1": 43, "rc0": 43, "dev1": 43, "rc1": 43, "decid": 43, "candid": 43, "simplest": 44, "_version": 44, "entir": 44, "request": 44, "pprint": 44, "enabl": 44, "ident": 44, "One": 44, "bumpversion_new_vers": 44}, "objects": {"": [[9, 0, 0, "-", "bumpversion"]], "bumpversion": [[10, 0, 0, "-", "__main__"], [9, 1, 1, "", "__version__"], [11, 0, 0, "-", "aliases"], [12, 0, 0, "-", "autocast"], [13, 0, 0, "-", "bump"], [14, 0, 0, "-", "cli"], [15, 0, 0, "-", "config"], [21, 0, 0, "-", "exceptions"], [22, 0, 0, "-", "files"], [23, 0, 0, "-", "indented_logger"], [24, 0, 0, "-", "scm"], [25, 0, 0, "-", "show"], [26, 0, 0, "-", "ui"], [27, 0, 0, "-", "utils"], [28, 0, 0, "-", "version_part"], [29, 0, 0, "-", "versioning"], [34, 0, 0, "-", "visualize"], [35, 0, 0, "-", "yaml_dump"]], "bumpversion.aliases": [[11, 2, 1, "", "AliasedGroup"]], "bumpversion.aliases.AliasedGroup": [[11, 3, 1, "", "get_command"], [11, 3, 1, "", "resolve_command"]], "bumpversion.autocast": [[12, 4, 1, "", "autocast_value"], [12, 4, 1, "", "boolify"], [12, 4, 1, "", "listify"], [12, 4, 1, "", "noneify"]], "bumpversion.bump": [[13, 4, 1, "", "commit_and_tag"], [13, 4, 1, "", "do_bump"], [13, 4, 1, "", "get_next_version"], [13, 1, 1, "", "logger"]], "bumpversion.cli": [[14, 4, 1, "", "bump"], [14, 4, 1, "", "cli"], [14, 1, 1, "", "logger"], [14, 4, 1, "", "replace"], [14, 4, 1, "", "sample_config"], [14, 4, 1, "", "show"], [14, 4, 1, "", "show_bump"]], "bumpversion.config": [[15, 1, 1, "", "DEFAULTS"], [15, 4, 1, "", "check_current_version"], [16, 0, 0, "-", "create"], [17, 0, 0, "-", "files"], [18, 0, 0, "-", "files_legacy"], [15, 4, 1, "", "get_configuration"], [15, 1, 1, "", "logger"], [19, 0, 0, "-", "models"], [20, 0, 0, "-", "utils"]], "bumpversion.config.create": [[16, 4, 1, "", "create_configuration"], [16, 4, 1, "", "get_defaults_from_dest"]], "bumpversion.config.files": [[17, 1, 1, "", "CONFIG_FILE_SEARCH_ORDER"], [17, 4, 1, "", "find_config_file"], [17, 1, 1, "", "logger"], [17, 4, 1, "", "read_config_file"], [17, 4, 1, "", "read_toml_file"], [17, 4, 1, "", "update_config_file"]], "bumpversion.config.files_legacy": [[18, 1, 1, "", "logger"], [18, 4, 1, "", "read_ini_file"], [18, 4, 1, "", "update_ini_config_file"]], "bumpversion.config.models": [[19, 2, 1, "", "Config"], [19, 2, 1, "", "FileChange"], [19, 1, 1, "", "logger"]], "bumpversion.config.models.Config": [[19, 3, 1, "", "_resolve_filemap"], [19, 5, 1, "", "_resolved_filemap"], [19, 3, 1, "", "add_files"], [19, 5, 1, "", "allow_dirty"], [19, 5, 1, "", "commit"], [19, 5, 1, "", "commit_args"], [19, 5, 1, "", "current_version"], [19, 5, 1, "", "excluded_paths"], [19, 5, 1, "", "files"], [19, 6, 1, "", "files_to_modify"], [19, 5, 1, "", "ignore_missing_version"], [19, 5, 1, "", "included_paths"], [19, 5, 1, "", "message"], [19, 5, 1, "", "model_config"], [19, 5, 1, "", "parse"], [19, 5, 1, "", "parts"], [19, 5, 1, "", "regex"], [19, 5, 1, "", "replace"], [19, 6, 1, "", "resolved_filemap"], [19, 5, 1, "", "scm_info"], [19, 5, 1, "", "search"], [19, 5, 1, "", "serialize"], [19, 5, 1, "", "sign_tags"], [19, 5, 1, "", "tag"], [19, 5, 1, "", "tag_message"], [19, 5, 1, "", "tag_name"], [19, 6, 1, "", "version_config"], [19, 3, 1, "", "version_spec"]], "bumpversion.config.models.FileChange": [[19, 3, 1, "", "__hash__"], [19, 5, 1, "", "filename"], [19, 3, 1, "", "get_search_pattern"], [19, 5, 1, "", "glob"], [19, 5, 1, "", "ignore_missing_version"], [19, 5, 1, "", "key_path"], [19, 5, 1, "", "parse"], [19, 5, 1, "", "regex"], [19, 5, 1, "", "replace"], [19, 5, 1, "", "search"], [19, 5, 1, "", "serialize"]], "bumpversion.config.utils": [[20, 4, 1, "", "get_all_file_configs"], [20, 4, 1, "", "get_all_part_configs"], [20, 4, 1, "", "resolve_glob_files"]], "bumpversion.exceptions": [[21, 7, 1, "", "BadInputError"], [21, 7, 1, "", "BumpVersionError"], [21, 7, 1, "", "ConfigurationError"], [21, 7, 1, "", "DirtyWorkingDirectoryError"], [21, 7, 1, "", "FormattingError"], [21, 7, 1, "", "InvalidVersionPartError"], [21, 7, 1, "", "MissingValueError"], [21, 7, 1, "", "SignedTagsError"], [21, 7, 1, "", "VersionNotFoundError"]], "bumpversion.files": [[22, 2, 1, "", "ConfiguredFile"], [22, 2, 1, "", "DataFileUpdater"], [22, 2, 1, "", "FileUpdater"], [22, 4, 1, "", "contains_pattern"], [22, 4, 1, "", "log_changes"], [22, 1, 1, "", "logger"], [22, 4, 1, "", "modify_files"], [22, 4, 1, "", "resolve_file_config"]], "bumpversion.files.ConfiguredFile": [[22, 3, 1, "", "__repr__"], [22, 3, 1, "", "__str__"], [22, 3, 1, "", "_contains_change_pattern"], [22, 3, 1, "", "get_file_contents"], [22, 3, 1, "", "make_file_change"], [22, 3, 1, "", "write_file_contents"]], "bumpversion.files.DataFileUpdater": [[22, 3, 1, "", "_update_toml_file"], [22, 3, 1, "", "update_file"]], "bumpversion.files.FileUpdater": [[22, 3, 1, "", "update_file"]], "bumpversion.indented_logger": [[23, 1, 1, "", "CURRENT_INDENT"], [23, 2, 1, "", "IndentedLoggerAdapter"]], "bumpversion.indented_logger.IndentedLoggerAdapter": [[23, 6, 1, "", "current_indent"], [23, 3, 1, "", "dedent"], [23, 3, 1, "", "indent"], [23, 6, 1, "", "indent_str"], [23, 3, 1, "", "process"], [23, 3, 1, "", "reset"]], "bumpversion.scm": [[24, 2, 1, "", "Git"], [24, 2, 1, "", "Mercurial"], [24, 2, 1, "", "SCMInfo"], [24, 2, 1, "", "SourceCodeManager"], [24, 4, 1, "", "get_scm_info"], [24, 1, 1, "", "logger"]], "bumpversion.scm.Git": [[24, 5, 1, "", "_ALL_TAGS_COMMAND"], [24, 5, 1, "", "_COMMIT_COMMAND"], [24, 5, 1, "", "_TEST_USABLE_COMMAND"], [24, 3, 1, "", "add_path"], [24, 3, 1, "", "assert_nondirty"], [24, 3, 1, "", "latest_tag_info"], [24, 3, 1, "", "tag"]], "bumpversion.scm.Mercurial": [[24, 5, 1, "", "_ALL_TAGS_COMMAND"], [24, 5, 1, "", "_COMMIT_COMMAND"], [24, 5, 1, "", "_TEST_USABLE_COMMAND"], [24, 3, 1, "", "add_path"], [24, 3, 1, "", "assert_nondirty"], [24, 3, 1, "", "latest_tag_info"], [24, 3, 1, "", "tag"]], "bumpversion.scm.SCMInfo": [[24, 3, 1, "", "__repr__"], [24, 3, 1, "", "__str__"], [24, 5, 1, "", "branch_name"], [24, 5, 1, "", "commit_sha"], [24, 5, 1, "", "current_version"], [24, 5, 1, "", "dirty"], [24, 5, 1, "", "distance_to_latest_tag"], [24, 5, 1, "", "short_branch_name"], [24, 5, 1, "", "tool"]], "bumpversion.scm.SourceCodeManager": [[24, 5, 1, "", "_ALL_TAGS_COMMAND"], [24, 5, 1, "", "_COMMIT_COMMAND"], [24, 5, 1, "", "_TEST_USABLE_COMMAND"], [24, 3, 1, "", "__repr__"], [24, 3, 1, "", "__str__"], [24, 3, 1, "", "add_path"], [24, 3, 1, "", "assert_nondirty"], [24, 3, 1, "", "commit"], [24, 3, 1, "", "commit_to_scm"], [24, 3, 1, "", "get_all_tags"], [24, 3, 1, "", "get_version_from_tag"], [24, 3, 1, "", "is_usable"], [24, 3, 1, "", "latest_tag_info"], [24, 3, 1, "", "tag"], [24, 3, 1, "", "tag_in_scm"]], "bumpversion.show": [[25, 1, 1, "", "OUTPUTTERS"], [25, 4, 1, "", "do_show"], [25, 4, 1, "", "log_list"], [25, 4, 1, "", "output_default"], [25, 4, 1, "", "output_json"], [25, 4, 1, "", "output_yaml"], [25, 4, 1, "", "resolve_name"]], "bumpversion.ui": [[26, 1, 1, "", "VERBOSITY"], [26, 4, 1, "", "get_indented_logger"], [26, 1, 1, "", "logger"], [26, 4, 1, "", "print_error"], [26, 4, 1, "", "print_info"], [26, 4, 1, "", "print_warning"], [26, 4, 1, "", "setup_logging"]], "bumpversion.utils": [[27, 4, 1, "", "base_context"], [27, 4, 1, "", "extract_regex_flags"], [27, 4, 1, "", "get_context"], [27, 4, 1, "", "get_nested_value"], [27, 4, 1, "", "get_overrides"], [27, 4, 1, "", "key_val_string"], [27, 4, 1, "", "labels_for_format"], [27, 4, 1, "", "prefixed_environ"], [27, 4, 1, "", "recursive_sort_dict"], [27, 4, 1, "", "set_nested_value"]], "bumpversion.version_part": [[28, 2, 1, "", "VersionConfig"], [28, 1, 1, "", "logger"]], "bumpversion.version_part.VersionConfig": [[28, 3, 1, "", "__eq__"], [28, 3, 1, "", "__repr__"], [28, 6, 1, "", "order"], [28, 3, 1, "", "parse"], [28, 3, 1, "", "serialize"]], "bumpversion.versioning": [[30, 0, 0, "-", "conventions"], [31, 0, 0, "-", "functions"], [32, 0, 0, "-", "models"], [33, 0, 0, "-", "serialization"]], "bumpversion.versioning.conventions": [[30, 1, 1, "", "PEP440_COMPONENT_CONFIGS"], [30, 1, 1, "", "PEP440_PATTERN"], [30, 1, 1, "", "PEP440_SERIALIZE_PATTERNS"], [30, 1, 1, "", "SEMVER_COMPONENT_CONFIGS"], [30, 1, 1, "", "SEMVER_PATTERN"], [30, 1, 1, "", "SEMVER_SERIALIZE_PATTERNS"], [30, 4, 1, "", "pep440_version_spec"], [30, 4, 1, "", "semver_spec"]], "bumpversion.versioning.functions": [[31, 2, 1, "", "IndependentFunction"], [31, 2, 1, "", "NumericFunction"], [31, 2, 1, "", "PartFunction"], [31, 2, 1, "", "ValuesFunction"]], "bumpversion.versioning.functions.IndependentFunction": [[31, 3, 1, "", "bump"]], "bumpversion.versioning.functions.NumericFunction": [[31, 5, 1, "", "FIRST_NUMERIC"], [31, 3, 1, "", "bump"]], "bumpversion.versioning.functions.PartFunction": [[31, 3, 1, "", "bump"], [31, 5, 1, "", "first_value"], [31, 5, 1, "", "independent"], [31, 5, 1, "", "optional_value"]], "bumpversion.versioning.functions.ValuesFunction": [[31, 3, 1, "", "bump"]], "bumpversion.versioning.models": [[32, 2, 1, "", "Version"], [32, 2, 1, "", "VersionComponent"], [32, 2, 1, "", "VersionComponentConfig"], [32, 2, 1, "", "VersionSpec"]], "bumpversion.versioning.models.Version": [[32, 3, 1, "", "__eq__"], [32, 3, 1, "", "__getitem__"], [32, 3, 1, "", "__iter__"], [32, 3, 1, "", "__len__"], [32, 3, 1, "", "__repr__"], [32, 3, 1, "", "bump"], [32, 3, 1, "", "required_components"], [32, 3, 1, "", "values"]], "bumpversion.versioning.models.VersionComponent": [[32, 3, 1, "", "__eq__"], [32, 3, 1, "", "__format__"], [32, 3, 1, "", "__repr__"], [32, 3, 1, "", "bump"], [32, 3, 1, "", "copy"], [32, 6, 1, "", "is_independent"], [32, 6, 1, "", "is_optional"], [32, 3, 1, "", "null"], [32, 6, 1, "", "value"]], "bumpversion.versioning.models.VersionComponentConfig": [[32, 3, 1, "", "create_component"], [32, 5, 1, "", "depends_on"], [32, 5, 1, "", "first_value"], [32, 5, 1, "", "independent"], [32, 5, 1, "", "optional_value"], [32, 5, 1, "", "values"]], "bumpversion.versioning.models.VersionSpec": [[32, 3, 1, "", "create_version"], [32, 3, 1, "", "get_dependents"]], "bumpversion.versioning.serialization": [[33, 1, 1, "", "logger"], [33, 4, 1, "", "multisort"], [33, 4, 1, "", "parse_version"], [33, 4, 1, "", "serialize"]], "bumpversion.visualize": [[34, 1, 1, "", "BOX_CHARS"], [34, 2, 1, "", "Border"], [34, 4, 1, "", "connection_str"], [34, 4, 1, "", "filter_version_parts"], [34, 4, 1, "", "labeled_line"], [34, 4, 1, "", "lead_string"], [34, 4, 1, "", "visualize"]], "bumpversion.visualize.Border": [[34, 5, 1, "", "corner_bottom_left"], [34, 5, 1, "", "corner_bottom_right"], [34, 5, 1, "", "corner_top_left"], [34, 5, 1, "", "corner_top_right"], [34, 5, 1, "", "cross"], [34, 5, 1, "", "divider_down"], [34, 5, 1, "", "divider_left"], [34, 5, 1, "", "divider_right"], [34, 5, 1, "", "divider_up"], [34, 5, 1, "", "line"], [34, 5, 1, "", "pipe"]], "bumpversion.yaml_dump": [[35, 1, 1, "", "DumperFunc"], [35, 1, 1, "", "INDENT"], [35, 2, 1, "", "YAMLDumpers"], [35, 1, 1, "", "YAML_DUMPERS"], [35, 4, 1, "", "dump"], [35, 4, 1, "", "format_bool"], [35, 4, 1, "", "format_date"], [35, 4, 1, "", "format_datetime"], [35, 4, 1, "", "format_dict"], [35, 4, 1, "", "format_float"], [35, 4, 1, "", "format_int"], [35, 4, 1, "", "format_none"], [35, 4, 1, "", "format_sequence"], [35, 4, 1, "", "format_str"]], "bumpversion.yaml_dump.YAMLDumpers": [[35, 3, 1, "", "add_dumper"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:method", "4": "py:function", "5": "py:attribute", "6": "py:property", "7": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"], "5": ["py", "attribute", "Python attribute"], "6": ["py", "property", "Python property"], "7": ["py", "exception", "Python exception"]}, "titleterms": {"changelog": [0, 8], "0": 0, "17": 0, "1": 0, "2024": 0, "01": 0, "25": 0, "fix": 0, "22": 0, "new": [0, 43], "updat": 0, "16": 0, "2": 0, "13": 0, "other": 0, "06": 0, "05": 0, "15": 0, "4": 0, "2023": 0, "12": 0, "29": 0, "3": 0, "18": 0, "14": 0, "11": 0, "04": 0, "09": 0, "26": 0, "10": 0, "9": 0, "08": 0, "07": 0, "03": 0, "8": 0, "7": 0, "6": 0, "23": 0, "5": 0, "20": 0, "24": 0, "contribut": [1, 8], "bump": [1, 7, 8, 13, 44], "my": [1, 7, 8], "version": [1, 4, 7, 8, 29, 30, 31, 32, 33, 37, 38, 41, 43, 44], "tabl": [1, 7], "content": [1, 7, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35], "code": [1, 38], "conduct": 1, "i": 1, "have": 1, "question": 1, "report": 1, "bug": 1, "befor": 1, "submit": 1, "how": [1, 5], "do": 1, "good": 1, "suggest": 1, "enhanc": 1, "an": 1, "your": 1, "first": [1, 41], "setup": 1, "run": 1, "test": 1, "instal": [1, 8], "pre": [1, 43], "commit": [1, 37], "hook": 1, "improv": 1, "The": 1, "document": 1, "styleguid": 1, "style": [1, 37], "messag": [1, 37], "join": 1, "project": 1, "team": 1, "attribut": 1, "explan": 2, "avoid": 3, "incorrect": 3, "replac": [3, 6, 37, 40, 44], "custom": 4, "format": [4, 38], "differ": 4, "file": [4, 6, 8, 17, 22, 37, 44], "To": 5, "guid": 5, "multipl": 6, "within": 6, "same": 6, "indic": 7, "overview": 8, "futur": 8, "direct": 8, "usag": [8, 44], "increment": [8, 41, 44], "part": [8, 37, 41], "configur": [8, 37, 40, 41, 43, 44], "command": [8, 36], "line": [8, 36], "option": [8, 41], "us": [8, 40], "script": 8, "develop": 8, "licens": 8, "bumpvers": [9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35], "subpackag": 9, "submodul": [9, 15, 29], "packag": [9, 15], "data": [9, 13, 14, 15, 17, 18, 19, 22, 23, 24, 25, 26, 28, 30, 33, 34, 35], "api": [9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35], "__main__": 10, "alias": 11, "modul": [11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35], "class": [11, 19, 22, 23, 24, 28, 31, 32, 34, 35], "autocast": 12, "function": [12, 13, 14, 15, 16, 17, 18, 20, 22, 24, 25, 26, 27, 30, 31, 33, 34, 35, 41], "cli": 14, "config": [15, 16, 17, 18, 19, 20], "creat": [16, 43], "files_legaci": 18, "model": [19, 32], "util": [20, 27], "except": 21, "indented_logg": 23, "scm": 24, "show": [25, 44], "ui": 26, "version_part": [28, 44], "convent": 30, "serial": [33, 37], "visual": [34, 43], "yaml_dump": 35, "interfac": 36, "global": 37, "allow_dirti": 37, "commit_arg": 37, "tag": 37, "sign_tag": 37, "tag_nam": 37, "tag_messag": 37, "current_vers": 37, "pars": 37, "search": [37, 40, 44], "ignore_missing_vers": 37, "toml": 37, "exampl": [37, 43], "ini": 37, "specif": 37, "valu": [37, 41], "optional_valu": 37, "first_valu": 37, "independ": [37, 41], "filenam": 37, "glob": 37, "context": 38, "escap": 38, "charact": [38, 40], "date": 38, "time": 38, "field": 38, "sourc": 38, "manag": 38, "environ": 38, "variabl": 38, "refer": [39, 41], "templat": 40, "string": 40, "regular": 40, "express": 40, "special": 40, "tutori": 42, "semant": 43, "default": 43, "path": 43, "support": 43, "releas": 43, "autom": 43, "number": 43, "pre_n": 43, "note": 44, "warn": 44, "inform": 44, "without": 44}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 60}, "alltitles": {"Changelog": [[0, "changelog"], [8, "changelog"]], "0.17.1 (2024-01-25)": [[0, "id1"]], "Fixes": [[0, "fixes"], [0, "id3"], [0, "id5"], [0, "id7"], [0, "id12"], [0, "id14"], [0, "id16"], [0, "id19"], [0, "id23"], [0, "id26"], [0, "id30"], [0, "id35"], [0, "id45"], [0, "id50"], [0, "id59"], [0, "id62"], [0, "id66"], [0, "id70"], [0, "id73"], [0, "id78"], [0, "id81"], [0, "id86"], [0, "id91"]], "0.17.0 (2024-01-22)": [[0, "id2"]], "New": [[0, "new"], [0, "id9"], [0, "id17"], [0, "id27"], [0, "id31"], [0, "id36"], [0, "id46"], [0, "id55"], [0, "id57"], [0, "id63"], [0, "id67"], [0, "id74"], [0, "id82"], [0, "id87"], [0, "id92"]], "Updates": [[0, "updates"], [0, "id21"], [0, "id24"], [0, "id28"], [0, "id33"], [0, "id38"], [0, "id41"], [0, "id43"], [0, "id48"], [0, "id53"], [0, "id68"], [0, "id76"], [0, "id84"], [0, "id89"], [0, "id94"]], "0.16.2 (2024-01-13)": [[0, "id4"]], "Other": [[0, "other"], [0, "id10"], [0, "id20"], [0, "id32"], [0, "id37"], [0, "id40"], [0, "id47"], [0, "id52"], [0, "id60"], [0, "id64"], [0, "id71"], [0, "id75"], [0, "id79"], [0, "id83"], [0, "id88"], [0, "id93"]], "0.16.1 (2024-01-06)": [[0, "id6"]], "0.16.0 (2024-01-05)": [[0, "id8"]], "0.15.4 (2023-12-29)": [[0, "id11"]], "0.15.3 (2023-12-18)": [[0, "id13"]], "0.15.2 (2023-12-18)": [[0, "id15"]], "0.15.1 (2023-12-18)": [[0, "id18"]], "0.15.0 (2023-12-16)": [[0, "id22"]], "0.14.0 (2023-12-15)": [[0, "id25"]], "0.13.0 (2023-12-06)": [[0, "id29"]], "0.12.0 (2023-11-04)": [[0, "id34"]], "0.11.0 (2023-09-26)": [[0, "id39"]], "0.10.0 (2023-09-05)": [[0, "id42"]], "0.9.3 (2023-08-25)": [[0, "id44"]], "0.9.2 (2023-08-07)": [[0, "id49"]], "0.9.1 (2023-08-03)": [[0, "id51"]], "0.9.0 (2023-08-03)": [[0, "id54"]], "0.8.0 (2023-07-13)": [[0, "id56"]], "0.7.1 (2023-07-12)": [[0, "id58"]], "0.7.0 (2023-07-10)": [[0, "id61"]], "0.6.0 (2023-06-23)": [[0, "id65"]], "0.5.1 (2023-06-14)": [[0, "id69"]], "0.5.0 (2023-06-12)": [[0, "id72"]], "0.4.1 (2023-06-09)": [[0, "id77"]], "0.4.0 (2023-04-20)": [[0, "id80"]], "0.3.0 (2023-04-17)": [[0, "id85"]], "0.2.0 (2023-04-14)": [[0, "id90"]], "0.1.0 (2023-03-24)": [[0, "id95"]], "Contributing to Bump My Version": [[1, "contributing-to-bump-my-version"]], "Table of Contents": [[1, "table-of-contents"]], "Code of Conduct": [[1, "code-of-conduct"]], "I Have a Question": [[1, "i-have-a-question"]], "Reporting Bugs": [[1, "reporting-bugs"]], "Before Submitting a Bug Report": [[1, "before-submitting-a-bug-report"]], "How Do I Submit a Good Bug Report?": [[1, "how-do-i-submit-a-good-bug-report"]], "Suggesting Enhancements": [[1, "suggesting-enhancements"]], "Before Submitting an Enhancement": [[1, "before-submitting-an-enhancement"]], "How Do I Submit a Good Enhancement Suggestion?": [[1, "how-do-i-submit-a-good-enhancement-suggestion"]], "Your First Code Contribution": [[1, "your-first-code-contribution"]], "Setup": [[1, "setup"]], "Run tests": [[1, "run-tests"]], "Install Pre-commit Hooks": [[1, "install-pre-commit-hooks"]], "Improving The Documentation": [[1, "improving-the-documentation"]], "Styleguides": [[1, "styleguides"]], "Coding Style": [[1, "coding-style"]], "Commit Messages": [[1, "commit-messages"]], "Join The Project Team": [[1, "join-the-project-team"]], "Attribution": [[1, "attribution"]], "Explanation": [[2, "explanation"]], "Avoiding incorrect replacements": [[3, "avoiding-incorrect-replacements"]], "Custom version formats in different files": [[4, "custom-version-formats-in-different-files"]], "How-To Guides": [[5, "how-to-guides"]], "Multiple replacements within the same file": [[6, "multiple-replacements-within-the-same-file"]], "Bump My Version": [[7, "bump-my-version"], [8, "bump-my-version"]], "Contents": [[7, null]], "Indices and tables": [[7, "indices-and-tables"]], "Overview": [[8, "overview"]], "Future Direction": [[8, "future-direction"]], "Installation": [[8, "installation"]], "Usage for version incrementing": [[8, "usage-for-version-incrementing"]], "part": [[8, "part"]], "file": [[8, "file"]], "Configuration file": [[8, "configuration-file"]], "Command-line Options": [[8, "command-line-options"]], "Using bump-my-version in a script": [[8, "using-bump-my-version-in-a-script"]], "Development & Contributing": [[8, "development-contributing"]], "License": [[8, "license"]], "bumpversion": [[9, "module-bumpversion"]], "Subpackages": [[9, "subpackages"]], "Submodules": [[9, "submodules"], [15, "submodules"], [29, "submodules"]], "Package Contents": [[9, "package-contents"], [15, "package-contents"]], "Data": [[9, "data"], [13, "data"], [14, "data"], [15, "data"], [17, "data"], [18, "data"], [19, "data"], [22, "data"], [23, "data"], [24, "data"], [25, "data"], [26, "data"], [28, "data"], [30, "data"], [33, "data"], [34, "data"], [35, "data"]], "API": [[9, "api"], [11, "api"], [12, "api"], [13, "api"], [14, "api"], [15, "api"], [16, "api"], [17, "api"], [18, "api"], [19, "api"], [20, "api"], [21, "api"], [22, "api"], [23, "api"], [24, "api"], [25, "api"], [26, "api"], [27, "api"], [28, "api"], [30, "api"], [31, "api"], [32, "api"], [33, "api"], [34, "api"], [35, "api"]], "bumpversion.__main__": [[10, "module-bumpversion.__main__"]], "bumpversion.aliases": [[11, "module-bumpversion.aliases"]], "Module Contents": [[11, "module-contents"], [12, "module-contents"], [13, "module-contents"], [14, "module-contents"], [16, "module-contents"], [17, "module-contents"], [18, "module-contents"], [19, "module-contents"], [20, "module-contents"], [21, "module-contents"], [22, "module-contents"], [23, "module-contents"], [24, "module-contents"], [25, "module-contents"], [26, "module-contents"], [27, "module-contents"], [28, "module-contents"], [30, "module-contents"], [31, "module-contents"], [32, "module-contents"], [33, "module-contents"], [34, "module-contents"], [35, "module-contents"]], "Classes": [[11, "classes"], [19, "classes"], [22, "classes"], [23, "classes"], [24, "classes"], [28, "classes"], [31, "classes"], [32, "classes"], [34, "classes"], [35, "classes"]], "bumpversion.autocast": [[12, "module-bumpversion.autocast"]], "Functions": [[12, "functions"], [13, "functions"], [14, "functions"], [15, "functions"], [16, "functions"], [17, "functions"], [18, "functions"], [20, "functions"], [22, "functions"], [24, "functions"], [25, "functions"], [26, "functions"], [27, "functions"], [30, "functions"], [33, "functions"], [34, "functions"], [35, "functions"]], "bumpversion.bump": [[13, "module-bumpversion.bump"]], "bumpversion.cli": [[14, "module-bumpversion.cli"]], "bumpversion.config": [[15, "module-bumpversion.config"]], "bumpversion.config.create": [[16, "module-bumpversion.config.create"]], "bumpversion.config.files": [[17, "module-bumpversion.config.files"]], "bumpversion.config.files_legacy": [[18, "module-bumpversion.config.files_legacy"]], "bumpversion.config.models": [[19, "module-bumpversion.config.models"]], "bumpversion.config.utils": [[20, "module-bumpversion.config.utils"]], "bumpversion.exceptions": [[21, "module-bumpversion.exceptions"]], "bumpversion.files": [[22, "module-bumpversion.files"]], "bumpversion.indented_logger": [[23, "module-bumpversion.indented_logger"]], "bumpversion.scm": [[24, "module-bumpversion.scm"]], "bumpversion.show": [[25, "module-bumpversion.show"]], "bumpversion.ui": [[26, "module-bumpversion.ui"]], "bumpversion.utils": [[27, "module-bumpversion.utils"]], "bumpversion.version_part": [[28, "module-bumpversion.version_part"]], "bumpversion.versioning": [[29, "module-bumpversion.versioning"]], "bumpversion.versioning.conventions": [[30, "module-bumpversion.versioning.conventions"]], "bumpversion.versioning.functions": [[31, "module-bumpversion.versioning.functions"]], "bumpversion.versioning.models": [[32, "module-bumpversion.versioning.models"]], "bumpversion.versioning.serialization": [[33, "module-bumpversion.versioning.serialization"]], "bumpversion.visualize": [[34, "module-bumpversion.visualize"]], "bumpversion.yaml_dump": [[35, "module-bumpversion.yaml_dump"]], "Command-line Interface": [[36, "command-line-interface"]], "Configuration": [[37, "configuration"]], "Configuration files": [[37, "configuration-files"]], "Global Configuration": [[37, "global-configuration"]], "allow_dirty": [[37, "allow-dirty"]], "commit": [[37, "commit"]], "message": [[37, "message"]], "commit_args": [[37, "commit-args"]], "tag": [[37, "tag"]], "sign_tags": [[37, "sign-tags"]], "tag_name": [[37, "tag-name"]], "tag_message": [[37, "tag-message"]], "current_version": [[37, "current-version"]], "parse": [[37, "parse"], [37, "id3"]], "serialize": [[37, "serialize"], [37, "id4"]], "search": [[37, "search"], [37, "id5"]], "replace": [[37, "replace"], [37, "id6"]], "ignore_missing_version": [[37, "ignore-missing-version"], [37, "id7"]], "TOML example": [[37, "toml-example"], [37, "id1"]], "INI-style example": [[37, "ini-style-example"], [37, "id2"]], "Version part-specific configuration": [[37, "version-part-specific-configuration"]], "values": [[37, "values"]], "optional_value": [[37, "optional-value"]], "first_value": [[37, "first-value"]], "independent": [[37, "independent"]], "File-specific configuration": [[37, "file-specific-configuration"]], "filename": [[37, "filename"]], "glob": [[37, "glob"]], "INI-style configuration files": [[37, "ini-style-configuration-files"]], "TOML configuration files": [[37, "toml-configuration-files"]], "Formatting context": [[38, "formatting-context"]], "Escaped characters": [[38, "escaped-characters"]], "Date and time fields": [[38, "date-and-time-fields"]], "Source code management fields": [[38, "source-code-management-fields"]], "Version fields": [[38, "version-fields"]], "Environment variables": [[38, "environment-variables"]], "Reference": [[39, "reference"], [41, "reference"]], "Search and replace configuration": [[40, "search-and-replace-configuration"]], "Using template strings": [[40, "using-template-strings"]], "Using regular expressions": [[40, "using-regular-expressions"]], "Regular expression special characters": [[40, "regular-expression-special-characters"]], "Version parts": [[41, "version-parts"]], "Version configuration": [[41, "version-configuration"]], "Version part configuration": [[41, "version-part-configuration"]], "Incrementing functions": [[41, "incrementing-functions"]], "Optional values": [[41, "optional-values"]], "First Values": [[41, "first-values"]], "Independent Values": [[41, "independent-values"]], "Tutorials": [[42, "tutorials"]], "Semantic versioning example": [[43, "semantic-versioning-example"]], "Create a default configuration": [[43, "create-a-default-configuration"]], "Visualizing the versioning path": [[43, "visualizing-the-versioning-path"]], "Supporting pre-release versions": [[43, "supporting-pre-release-versions"]], "Visualizing the new versioning path": [[43, "visualizing-the-new-versioning-path"]], "Automating the pre-release numbering": [[43, "automating-the-pre-release-numbering"]], "Visualizing the pre_n versioning path": [[43, "visualizing-the-pre-n-versioning-path"]], "Usage": [[44, "usage"]], "NOTE": [[44, null], [44, null]], "WARNING": [[44, null]], "Incrementing a version": [[44, "incrementing-a-version"]], "VERSION_PART": [[44, "version-part"]], "FILES": [[44, "files"]], "Showing configuration information": [[44, "showing-configuration-information"]], "Searching and replacing without bumping": [[44, "searching-and-replacing-without-bumping"]]}, "indexentries": {"__version__ (in module bumpversion)": [[9, "bumpversion.__version__"]], "bumpversion": [[9, "module-bumpversion"]], "module": [[9, "module-bumpversion"], [10, "module-bumpversion.__main__"], [11, "module-bumpversion.aliases"], [12, "module-bumpversion.autocast"], [13, "module-bumpversion.bump"], [14, "module-bumpversion.cli"], [15, "module-bumpversion.config"], [16, "module-bumpversion.config.create"], [17, "module-bumpversion.config.files"], [18, "module-bumpversion.config.files_legacy"], [19, "module-bumpversion.config.models"], [20, "module-bumpversion.config.utils"], [21, "module-bumpversion.exceptions"], [22, "module-bumpversion.files"], [23, "module-bumpversion.indented_logger"], [24, "module-bumpversion.scm"], [25, "module-bumpversion.show"], [26, "module-bumpversion.ui"], [27, "module-bumpversion.utils"], [28, "module-bumpversion.version_part"], [29, "module-bumpversion.versioning"], [30, "module-bumpversion.versioning.conventions"], [31, "module-bumpversion.versioning.functions"], [32, "module-bumpversion.versioning.models"], [33, "module-bumpversion.versioning.serialization"], [34, "module-bumpversion.visualize"], [35, "module-bumpversion.yaml_dump"]], "bumpversion.__main__": [[10, "module-bumpversion.__main__"]], "aliasedgroup (class in bumpversion.aliases)": [[11, "bumpversion.aliases.AliasedGroup"]], "bumpversion.aliases": [[11, "module-bumpversion.aliases"]], "get_command() (bumpversion.aliases.aliasedgroup method)": [[11, "bumpversion.aliases.AliasedGroup.get_command"]], "resolve_command() (bumpversion.aliases.aliasedgroup method)": [[11, "bumpversion.aliases.AliasedGroup.resolve_command"]], "autocast_value() (in module bumpversion.autocast)": [[12, "bumpversion.autocast.autocast_value"]], "boolify() (in module bumpversion.autocast)": [[12, "bumpversion.autocast.boolify"]], "bumpversion.autocast": [[12, "module-bumpversion.autocast"]], "listify() (in module bumpversion.autocast)": [[12, "bumpversion.autocast.listify"]], "noneify() (in module bumpversion.autocast)": [[12, "bumpversion.autocast.noneify"]], "bumpversion.bump": [[13, "module-bumpversion.bump"]], "commit_and_tag() (in module bumpversion.bump)": [[13, "bumpversion.bump.commit_and_tag"]], "do_bump() (in module bumpversion.bump)": [[13, "bumpversion.bump.do_bump"]], "get_next_version() (in module bumpversion.bump)": [[13, "bumpversion.bump.get_next_version"]], "logger (in module bumpversion.bump)": [[13, "bumpversion.bump.logger"]], "bump() (in module bumpversion.cli)": [[14, "bumpversion.cli.bump"]], "bumpversion.cli": [[14, "module-bumpversion.cli"]], "cli() (in module bumpversion.cli)": [[14, "bumpversion.cli.cli"]], "logger (in module bumpversion.cli)": [[14, "bumpversion.cli.logger"]], "replace() (in module bumpversion.cli)": [[14, "bumpversion.cli.replace"]], "sample_config() (in module bumpversion.cli)": [[14, "bumpversion.cli.sample_config"]], "show() (in module bumpversion.cli)": [[14, "bumpversion.cli.show"]], "show_bump() (in module bumpversion.cli)": [[14, "bumpversion.cli.show_bump"]], "defaults (in module bumpversion.config)": [[15, "bumpversion.config.DEFAULTS"]], "bumpversion.config": [[15, "module-bumpversion.config"]], "check_current_version() (in module bumpversion.config)": [[15, "bumpversion.config.check_current_version"]], "get_configuration() (in module bumpversion.config)": [[15, "bumpversion.config.get_configuration"]], "logger (in module bumpversion.config)": [[15, "bumpversion.config.logger"]], "bumpversion.config.create": [[16, "module-bumpversion.config.create"]], "create_configuration() (in module bumpversion.config.create)": [[16, "bumpversion.config.create.create_configuration"]], "get_defaults_from_dest() (in module bumpversion.config.create)": [[16, "bumpversion.config.create.get_defaults_from_dest"]], "config_file_search_order (in module bumpversion.config.files)": [[17, "bumpversion.config.files.CONFIG_FILE_SEARCH_ORDER"]], "bumpversion.config.files": [[17, "module-bumpversion.config.files"]], "find_config_file() (in module bumpversion.config.files)": [[17, "bumpversion.config.files.find_config_file"]], "logger (in module bumpversion.config.files)": [[17, "bumpversion.config.files.logger"]], "read_config_file() (in module bumpversion.config.files)": [[17, "bumpversion.config.files.read_config_file"]], "read_toml_file() (in module bumpversion.config.files)": [[17, "bumpversion.config.files.read_toml_file"]], "update_config_file() (in module bumpversion.config.files)": [[17, "bumpversion.config.files.update_config_file"]], "bumpversion.config.files_legacy": [[18, "module-bumpversion.config.files_legacy"]], "logger (in module bumpversion.config.files_legacy)": [[18, "bumpversion.config.files_legacy.logger"]], "read_ini_file() (in module bumpversion.config.files_legacy)": [[18, "bumpversion.config.files_legacy.read_ini_file"]], "update_ini_config_file() (in module bumpversion.config.files_legacy)": [[18, "bumpversion.config.files_legacy.update_ini_config_file"]], "config (class in bumpversion.config.models)": [[19, "bumpversion.config.models.Config"]], "filechange (class in bumpversion.config.models)": [[19, "bumpversion.config.models.FileChange"]], "__hash__() (bumpversion.config.models.filechange method)": [[19, "bumpversion.config.models.FileChange.__hash__"]], "_resolve_filemap() (bumpversion.config.models.config method)": [[19, "bumpversion.config.models.Config._resolve_filemap"]], "_resolved_filemap (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config._resolved_filemap"]], "add_files() (bumpversion.config.models.config method)": [[19, "bumpversion.config.models.Config.add_files"]], "allow_dirty (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.allow_dirty"]], "bumpversion.config.models": [[19, "module-bumpversion.config.models"]], "commit (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.commit"]], "commit_args (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.commit_args"]], "current_version (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.current_version"]], "excluded_paths (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.excluded_paths"]], "filename (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.filename"]], "files (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.files"]], "files_to_modify (bumpversion.config.models.config property)": [[19, "bumpversion.config.models.Config.files_to_modify"]], "get_search_pattern() (bumpversion.config.models.filechange method)": [[19, "bumpversion.config.models.FileChange.get_search_pattern"]], "glob (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.glob"]], "ignore_missing_version (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.ignore_missing_version"]], "ignore_missing_version (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.ignore_missing_version"]], "included_paths (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.included_paths"]], "key_path (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.key_path"]], "logger (in module bumpversion.config.models)": [[19, "bumpversion.config.models.logger"]], "message (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.message"]], "model_config (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.model_config"]], "parse (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.parse"]], "parse (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.parse"]], "parts (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.parts"]], "regex (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.regex"]], "regex (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.regex"]], "replace (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.replace"]], "replace (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.replace"]], "resolved_filemap (bumpversion.config.models.config property)": [[19, "bumpversion.config.models.Config.resolved_filemap"]], "scm_info (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.scm_info"]], "search (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.search"]], "search (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.search"]], "serialize (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.serialize"]], "serialize (bumpversion.config.models.filechange attribute)": [[19, "bumpversion.config.models.FileChange.serialize"]], "sign_tags (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.sign_tags"]], "tag (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.tag"]], "tag_message (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.tag_message"]], "tag_name (bumpversion.config.models.config attribute)": [[19, "bumpversion.config.models.Config.tag_name"]], "version_config (bumpversion.config.models.config property)": [[19, "bumpversion.config.models.Config.version_config"]], "version_spec() (bumpversion.config.models.config method)": [[19, "bumpversion.config.models.Config.version_spec"]], "bumpversion.config.utils": [[20, "module-bumpversion.config.utils"]], "get_all_file_configs() (in module bumpversion.config.utils)": [[20, "bumpversion.config.utils.get_all_file_configs"]], "get_all_part_configs() (in module bumpversion.config.utils)": [[20, "bumpversion.config.utils.get_all_part_configs"]], "resolve_glob_files() (in module bumpversion.config.utils)": [[20, "bumpversion.config.utils.resolve_glob_files"]], "badinputerror": [[21, "bumpversion.exceptions.BadInputError"]], "bumpversionerror": [[21, "bumpversion.exceptions.BumpVersionError"]], "configurationerror": [[21, "bumpversion.exceptions.ConfigurationError"]], "dirtyworkingdirectoryerror": [[21, "bumpversion.exceptions.DirtyWorkingDirectoryError"]], "formattingerror": [[21, "bumpversion.exceptions.FormattingError"]], "invalidversionparterror": [[21, "bumpversion.exceptions.InvalidVersionPartError"]], "missingvalueerror": [[21, "bumpversion.exceptions.MissingValueError"]], "signedtagserror": [[21, "bumpversion.exceptions.SignedTagsError"]], "versionnotfounderror": [[21, "bumpversion.exceptions.VersionNotFoundError"]], "bumpversion.exceptions": [[21, "module-bumpversion.exceptions"]], "configuredfile (class in bumpversion.files)": [[22, "bumpversion.files.ConfiguredFile"]], "datafileupdater (class in bumpversion.files)": [[22, "bumpversion.files.DataFileUpdater"]], "fileupdater (class in bumpversion.files)": [[22, "bumpversion.files.FileUpdater"]], "__repr__() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.__repr__"]], "__str__() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.__str__"]], "_contains_change_pattern() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile._contains_change_pattern"]], "_update_toml_file() (bumpversion.files.datafileupdater method)": [[22, "bumpversion.files.DataFileUpdater._update_toml_file"]], "bumpversion.files": [[22, "module-bumpversion.files"]], "contains_pattern() (in module bumpversion.files)": [[22, "bumpversion.files.contains_pattern"]], "get_file_contents() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.get_file_contents"]], "log_changes() (in module bumpversion.files)": [[22, "bumpversion.files.log_changes"]], "logger (in module bumpversion.files)": [[22, "bumpversion.files.logger"]], "make_file_change() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.make_file_change"]], "modify_files() (in module bumpversion.files)": [[22, "bumpversion.files.modify_files"]], "resolve_file_config() (in module bumpversion.files)": [[22, "bumpversion.files.resolve_file_config"]], "update_file() (bumpversion.files.datafileupdater method)": [[22, "bumpversion.files.DataFileUpdater.update_file"]], "update_file() (bumpversion.files.fileupdater method)": [[22, "bumpversion.files.FileUpdater.update_file"]], "write_file_contents() (bumpversion.files.configuredfile method)": [[22, "bumpversion.files.ConfiguredFile.write_file_contents"]], "current_indent (in module bumpversion.indented_logger)": [[23, "bumpversion.indented_logger.CURRENT_INDENT"]], "indentedloggeradapter (class in bumpversion.indented_logger)": [[23, "bumpversion.indented_logger.IndentedLoggerAdapter"]], "bumpversion.indented_logger": [[23, "module-bumpversion.indented_logger"]], "current_indent (bumpversion.indented_logger.indentedloggeradapter property)": [[23, "bumpversion.indented_logger.IndentedLoggerAdapter.current_indent"]], "dedent() (bumpversion.indented_logger.indentedloggeradapter method)": [[23, "bumpversion.indented_logger.IndentedLoggerAdapter.dedent"]], "indent() (bumpversion.indented_logger.indentedloggeradapter method)": [[23, "bumpversion.indented_logger.IndentedLoggerAdapter.indent"]], "indent_str (bumpversion.indented_logger.indentedloggeradapter property)": [[23, "bumpversion.indented_logger.IndentedLoggerAdapter.indent_str"]], "process() (bumpversion.indented_logger.indentedloggeradapter method)": [[23, "bumpversion.indented_logger.IndentedLoggerAdapter.process"]], "reset() (bumpversion.indented_logger.indentedloggeradapter method)": [[23, "bumpversion.indented_logger.IndentedLoggerAdapter.reset"]], "git (class in bumpversion.scm)": [[24, "bumpversion.scm.Git"]], "mercurial (class in bumpversion.scm)": [[24, "bumpversion.scm.Mercurial"]], "scminfo (class in bumpversion.scm)": [[24, "bumpversion.scm.SCMInfo"]], "sourcecodemanager (class in bumpversion.scm)": [[24, "bumpversion.scm.SourceCodeManager"]], "_all_tags_command (bumpversion.scm.git attribute)": [[24, "bumpversion.scm.Git._ALL_TAGS_COMMAND"]], "_all_tags_command (bumpversion.scm.mercurial attribute)": [[24, "bumpversion.scm.Mercurial._ALL_TAGS_COMMAND"]], "_all_tags_command (bumpversion.scm.sourcecodemanager attribute)": [[24, "bumpversion.scm.SourceCodeManager._ALL_TAGS_COMMAND"]], "_commit_command (bumpversion.scm.git attribute)": [[24, "bumpversion.scm.Git._COMMIT_COMMAND"]], "_commit_command (bumpversion.scm.mercurial attribute)": [[24, "bumpversion.scm.Mercurial._COMMIT_COMMAND"]], "_commit_command (bumpversion.scm.sourcecodemanager attribute)": [[24, "bumpversion.scm.SourceCodeManager._COMMIT_COMMAND"]], "_test_usable_command (bumpversion.scm.git attribute)": [[24, "bumpversion.scm.Git._TEST_USABLE_COMMAND"]], "_test_usable_command (bumpversion.scm.mercurial attribute)": [[24, "bumpversion.scm.Mercurial._TEST_USABLE_COMMAND"]], "_test_usable_command (bumpversion.scm.sourcecodemanager attribute)": [[24, "bumpversion.scm.SourceCodeManager._TEST_USABLE_COMMAND"]], "__repr__() (bumpversion.scm.scminfo method)": [[24, "bumpversion.scm.SCMInfo.__repr__"]], "__repr__() (bumpversion.scm.sourcecodemanager method)": [[24, "bumpversion.scm.SourceCodeManager.__repr__"]], "__str__() (bumpversion.scm.scminfo method)": [[24, "bumpversion.scm.SCMInfo.__str__"]], "__str__() (bumpversion.scm.sourcecodemanager method)": [[24, "bumpversion.scm.SourceCodeManager.__str__"]], "add_path() (bumpversion.scm.git class method)": [[24, "bumpversion.scm.Git.add_path"]], "add_path() (bumpversion.scm.mercurial class method)": [[24, "bumpversion.scm.Mercurial.add_path"]], "add_path() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.add_path"]], "assert_nondirty() (bumpversion.scm.git class method)": [[24, "bumpversion.scm.Git.assert_nondirty"]], "assert_nondirty() (bumpversion.scm.mercurial class method)": [[24, "bumpversion.scm.Mercurial.assert_nondirty"]], "assert_nondirty() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.assert_nondirty"]], "branch_name (bumpversion.scm.scminfo attribute)": [[24, "bumpversion.scm.SCMInfo.branch_name"]], "bumpversion.scm": [[24, "module-bumpversion.scm"]], "commit() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.commit"]], "commit_sha (bumpversion.scm.scminfo attribute)": [[24, "bumpversion.scm.SCMInfo.commit_sha"]], "commit_to_scm() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.commit_to_scm"]], "current_version (bumpversion.scm.scminfo attribute)": [[24, "bumpversion.scm.SCMInfo.current_version"]], "dirty (bumpversion.scm.scminfo attribute)": [[24, "bumpversion.scm.SCMInfo.dirty"]], "distance_to_latest_tag (bumpversion.scm.scminfo attribute)": [[24, "bumpversion.scm.SCMInfo.distance_to_latest_tag"]], "get_all_tags() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.get_all_tags"]], "get_scm_info() (in module bumpversion.scm)": [[24, "bumpversion.scm.get_scm_info"]], "get_version_from_tag() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.get_version_from_tag"]], "is_usable() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.is_usable"]], "latest_tag_info() (bumpversion.scm.git class method)": [[24, "bumpversion.scm.Git.latest_tag_info"]], "latest_tag_info() (bumpversion.scm.mercurial class method)": [[24, "bumpversion.scm.Mercurial.latest_tag_info"]], "latest_tag_info() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.latest_tag_info"]], "logger (in module bumpversion.scm)": [[24, "bumpversion.scm.logger"]], "short_branch_name (bumpversion.scm.scminfo attribute)": [[24, "bumpversion.scm.SCMInfo.short_branch_name"]], "tag() (bumpversion.scm.git class method)": [[24, "bumpversion.scm.Git.tag"]], "tag() (bumpversion.scm.mercurial class method)": [[24, "bumpversion.scm.Mercurial.tag"]], "tag() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.tag"]], "tag_in_scm() (bumpversion.scm.sourcecodemanager class method)": [[24, "bumpversion.scm.SourceCodeManager.tag_in_scm"]], "tool (bumpversion.scm.scminfo attribute)": [[24, "bumpversion.scm.SCMInfo.tool"]], "outputters (in module bumpversion.show)": [[25, "bumpversion.show.OUTPUTTERS"]], "bumpversion.show": [[25, "module-bumpversion.show"]], "do_show() (in module bumpversion.show)": [[25, "bumpversion.show.do_show"]], "log_list() (in module bumpversion.show)": [[25, "bumpversion.show.log_list"]], "output_default() (in module bumpversion.show)": [[25, "bumpversion.show.output_default"]], "output_json() (in module bumpversion.show)": [[25, "bumpversion.show.output_json"]], "output_yaml() (in module bumpversion.show)": [[25, "bumpversion.show.output_yaml"]], "resolve_name() (in module bumpversion.show)": [[25, "bumpversion.show.resolve_name"]], "verbosity (in module bumpversion.ui)": [[26, "bumpversion.ui.VERBOSITY"]], "bumpversion.ui": [[26, "module-bumpversion.ui"]], "get_indented_logger() (in module bumpversion.ui)": [[26, "bumpversion.ui.get_indented_logger"]], "logger (in module bumpversion.ui)": [[26, "bumpversion.ui.logger"]], "print_error() (in module bumpversion.ui)": [[26, "bumpversion.ui.print_error"]], "print_info() (in module bumpversion.ui)": [[26, "bumpversion.ui.print_info"]], "print_warning() (in module bumpversion.ui)": [[26, "bumpversion.ui.print_warning"]], "setup_logging() (in module bumpversion.ui)": [[26, "bumpversion.ui.setup_logging"]], "base_context() (in module bumpversion.utils)": [[27, "bumpversion.utils.base_context"]], "bumpversion.utils": [[27, "module-bumpversion.utils"]], "extract_regex_flags() (in module bumpversion.utils)": [[27, "bumpversion.utils.extract_regex_flags"]], "get_context() (in module bumpversion.utils)": [[27, "bumpversion.utils.get_context"]], "get_nested_value() (in module bumpversion.utils)": [[27, "bumpversion.utils.get_nested_value"]], "get_overrides() (in module bumpversion.utils)": [[27, "bumpversion.utils.get_overrides"]], "key_val_string() (in module bumpversion.utils)": [[27, "bumpversion.utils.key_val_string"]], "labels_for_format() (in module bumpversion.utils)": [[27, "bumpversion.utils.labels_for_format"]], "prefixed_environ() (in module bumpversion.utils)": [[27, "bumpversion.utils.prefixed_environ"]], "recursive_sort_dict() (in module bumpversion.utils)": [[27, "bumpversion.utils.recursive_sort_dict"]], "set_nested_value() (in module bumpversion.utils)": [[27, "bumpversion.utils.set_nested_value"]], "versionconfig (class in bumpversion.version_part)": [[28, "bumpversion.version_part.VersionConfig"]], "__eq__() (bumpversion.version_part.versionconfig method)": [[28, "bumpversion.version_part.VersionConfig.__eq__"]], "__repr__() (bumpversion.version_part.versionconfig method)": [[28, "bumpversion.version_part.VersionConfig.__repr__"]], "bumpversion.version_part": [[28, "module-bumpversion.version_part"]], "logger (in module bumpversion.version_part)": [[28, "bumpversion.version_part.logger"]], "order (bumpversion.version_part.versionconfig property)": [[28, "bumpversion.version_part.VersionConfig.order"]], "parse() (bumpversion.version_part.versionconfig method)": [[28, "bumpversion.version_part.VersionConfig.parse"]], "serialize() (bumpversion.version_part.versionconfig method)": [[28, "bumpversion.version_part.VersionConfig.serialize"]], "bumpversion.versioning": [[29, "module-bumpversion.versioning"]], "pep440_component_configs (in module bumpversion.versioning.conventions)": [[30, "bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS"]], "pep440_pattern (in module bumpversion.versioning.conventions)": [[30, "bumpversion.versioning.conventions.PEP440_PATTERN"]], "pep440_serialize_patterns (in module bumpversion.versioning.conventions)": [[30, "bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS"]], "semver_component_configs (in module bumpversion.versioning.conventions)": [[30, "bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS"]], "semver_pattern (in module bumpversion.versioning.conventions)": [[30, "bumpversion.versioning.conventions.SEMVER_PATTERN"]], "semver_serialize_patterns (in module bumpversion.versioning.conventions)": [[30, "bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS"]], "bumpversion.versioning.conventions": [[30, "module-bumpversion.versioning.conventions"]], "pep440_version_spec() (in module bumpversion.versioning.conventions)": [[30, "bumpversion.versioning.conventions.pep440_version_spec"]], "semver_spec() (in module bumpversion.versioning.conventions)": [[30, "bumpversion.versioning.conventions.semver_spec"]], "first_numeric (bumpversion.versioning.functions.numericfunction attribute)": [[31, "bumpversion.versioning.functions.NumericFunction.FIRST_NUMERIC"]], "independentfunction (class in bumpversion.versioning.functions)": [[31, "bumpversion.versioning.functions.IndependentFunction"]], "numericfunction (class in bumpversion.versioning.functions)": [[31, "bumpversion.versioning.functions.NumericFunction"]], "partfunction (class in bumpversion.versioning.functions)": [[31, "bumpversion.versioning.functions.PartFunction"]], "valuesfunction (class in bumpversion.versioning.functions)": [[31, "bumpversion.versioning.functions.ValuesFunction"]], "bump() (bumpversion.versioning.functions.independentfunction method)": [[31, "bumpversion.versioning.functions.IndependentFunction.bump"]], "bump() (bumpversion.versioning.functions.numericfunction method)": [[31, "bumpversion.versioning.functions.NumericFunction.bump"]], "bump() (bumpversion.versioning.functions.partfunction method)": [[31, "bumpversion.versioning.functions.PartFunction.bump"]], "bump() (bumpversion.versioning.functions.valuesfunction method)": [[31, "bumpversion.versioning.functions.ValuesFunction.bump"]], "bumpversion.versioning.functions": [[31, "module-bumpversion.versioning.functions"]], "first_value (bumpversion.versioning.functions.partfunction attribute)": [[31, "bumpversion.versioning.functions.PartFunction.first_value"]], "independent (bumpversion.versioning.functions.partfunction attribute)": [[31, "bumpversion.versioning.functions.PartFunction.independent"]], "optional_value (bumpversion.versioning.functions.partfunction attribute)": [[31, "bumpversion.versioning.functions.PartFunction.optional_value"]], "version (class in bumpversion.versioning.models)": [[32, "bumpversion.versioning.models.Version"]], "versioncomponent (class in bumpversion.versioning.models)": [[32, "bumpversion.versioning.models.VersionComponent"]], "versioncomponentconfig (class in bumpversion.versioning.models)": [[32, "bumpversion.versioning.models.VersionComponentConfig"]], "versionspec (class in bumpversion.versioning.models)": [[32, "bumpversion.versioning.models.VersionSpec"]], "__eq__() (bumpversion.versioning.models.version method)": [[32, "bumpversion.versioning.models.Version.__eq__"]], "__eq__() (bumpversion.versioning.models.versioncomponent method)": [[32, "bumpversion.versioning.models.VersionComponent.__eq__"]], "__format__() (bumpversion.versioning.models.versioncomponent method)": [[32, "bumpversion.versioning.models.VersionComponent.__format__"]], "__getitem__() (bumpversion.versioning.models.version method)": [[32, "bumpversion.versioning.models.Version.__getitem__"]], "__iter__() (bumpversion.versioning.models.version method)": [[32, "bumpversion.versioning.models.Version.__iter__"]], "__len__() (bumpversion.versioning.models.version method)": [[32, "bumpversion.versioning.models.Version.__len__"]], "__repr__() (bumpversion.versioning.models.version method)": [[32, "bumpversion.versioning.models.Version.__repr__"]], "__repr__() (bumpversion.versioning.models.versioncomponent method)": [[32, "bumpversion.versioning.models.VersionComponent.__repr__"]], "bump() (bumpversion.versioning.models.version method)": [[32, "bumpversion.versioning.models.Version.bump"]], "bump() (bumpversion.versioning.models.versioncomponent method)": [[32, "bumpversion.versioning.models.VersionComponent.bump"]], "bumpversion.versioning.models": [[32, "module-bumpversion.versioning.models"]], "copy() (bumpversion.versioning.models.versioncomponent method)": [[32, "bumpversion.versioning.models.VersionComponent.copy"]], "create_component() (bumpversion.versioning.models.versioncomponentconfig method)": [[32, "bumpversion.versioning.models.VersionComponentConfig.create_component"]], "create_version() (bumpversion.versioning.models.versionspec method)": [[32, "bumpversion.versioning.models.VersionSpec.create_version"]], "depends_on (bumpversion.versioning.models.versioncomponentconfig attribute)": [[32, "bumpversion.versioning.models.VersionComponentConfig.depends_on"]], "first_value (bumpversion.versioning.models.versioncomponentconfig attribute)": [[32, "bumpversion.versioning.models.VersionComponentConfig.first_value"]], "get_dependents() (bumpversion.versioning.models.versionspec method)": [[32, "bumpversion.versioning.models.VersionSpec.get_dependents"]], "independent (bumpversion.versioning.models.versioncomponentconfig attribute)": [[32, "bumpversion.versioning.models.VersionComponentConfig.independent"]], "is_independent (bumpversion.versioning.models.versioncomponent property)": [[32, "bumpversion.versioning.models.VersionComponent.is_independent"]], "is_optional (bumpversion.versioning.models.versioncomponent property)": [[32, "bumpversion.versioning.models.VersionComponent.is_optional"]], "null() (bumpversion.versioning.models.versioncomponent method)": [[32, "bumpversion.versioning.models.VersionComponent.null"]], "optional_value (bumpversion.versioning.models.versioncomponentconfig attribute)": [[32, "bumpversion.versioning.models.VersionComponentConfig.optional_value"]], "required_components() (bumpversion.versioning.models.version method)": [[32, "bumpversion.versioning.models.Version.required_components"]], "value (bumpversion.versioning.models.versioncomponent property)": [[32, "bumpversion.versioning.models.VersionComponent.value"]], "values (bumpversion.versioning.models.versioncomponentconfig attribute)": [[32, "bumpversion.versioning.models.VersionComponentConfig.values"]], "values() (bumpversion.versioning.models.version method)": [[32, "bumpversion.versioning.models.Version.values"]], "bumpversion.versioning.serialization": [[33, "module-bumpversion.versioning.serialization"]], "logger (in module bumpversion.versioning.serialization)": [[33, "bumpversion.versioning.serialization.logger"]], "multisort() (in module bumpversion.versioning.serialization)": [[33, "bumpversion.versioning.serialization.multisort"]], "parse_version() (in module bumpversion.versioning.serialization)": [[33, "bumpversion.versioning.serialization.parse_version"]], "serialize() (in module bumpversion.versioning.serialization)": [[33, "bumpversion.versioning.serialization.serialize"]], "box_chars (in module bumpversion.visualize)": [[34, "bumpversion.visualize.BOX_CHARS"]], "border (class in bumpversion.visualize)": [[34, "bumpversion.visualize.Border"]], "bumpversion.visualize": [[34, "module-bumpversion.visualize"]], "connection_str() (in module bumpversion.visualize)": [[34, "bumpversion.visualize.connection_str"]], "corner_bottom_left (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.corner_bottom_left"]], "corner_bottom_right (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.corner_bottom_right"]], "corner_top_left (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.corner_top_left"]], "corner_top_right (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.corner_top_right"]], "cross (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.cross"]], "divider_down (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.divider_down"]], "divider_left (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.divider_left"]], "divider_right (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.divider_right"]], "divider_up (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.divider_up"]], "filter_version_parts() (in module bumpversion.visualize)": [[34, "bumpversion.visualize.filter_version_parts"]], "labeled_line() (in module bumpversion.visualize)": [[34, "bumpversion.visualize.labeled_line"]], "lead_string() (in module bumpversion.visualize)": [[34, "bumpversion.visualize.lead_string"]], "line (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.line"]], "pipe (bumpversion.visualize.border attribute)": [[34, "bumpversion.visualize.Border.pipe"]], "visualize() (in module bumpversion.visualize)": [[34, "bumpversion.visualize.visualize"]], "dumperfunc (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.DumperFunc"]], "indent (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.INDENT"]], "yamldumpers (class in bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.YAMLDumpers"]], "yaml_dumpers (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.YAML_DUMPERS"]], "add_dumper() (bumpversion.yaml_dump.yamldumpers method)": [[35, "bumpversion.yaml_dump.YAMLDumpers.add_dumper"]], "bumpversion.yaml_dump": [[35, "module-bumpversion.yaml_dump"]], "dump() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.dump"]], "format_bool() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_bool"]], "format_date() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_date"]], "format_datetime() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_datetime"]], "format_dict() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_dict"]], "format_float() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_float"]], "format_int() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_int"]], "format_none() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_none"]], "format_sequence() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_sequence"]], "format_str() (in module bumpversion.yaml_dump)": [[35, "bumpversion.yaml_dump.format_str"]]}}) \ No newline at end of file diff --git a/tutorials/index.html b/tutorials/index.html index cdc7f72e..14a1fe4b 100644 --- a/tutorials/index.html +++ b/tutorials/index.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/tutorials/semantic-versioning-example.html b/tutorials/semantic-versioning-example.html index 048fa4ef..a6bdeb8c 100644 --- a/tutorials/semantic-versioning-example.html +++ b/tutorials/semantic-versioning-example.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation diff --git a/usage.html b/usage.html index c90ac2d1..813b8472 100644 --- a/usage.html +++ b/usage.html @@ -185,6 +185,13 @@
  • bumpversion.config.files_legacy
    • +
  • bumpversion.versioning +
  • bumpversion.yaml_dump
  • bumpversion.show
  • bumpversion.ui
    • @@ -195,7 +202,6 @@
  • bumpversion.files
  • bumpversion.bump
  • bumpversion.indented_logger
    • -
  • bumpversion.functions
  • bumpversion.exceptions
  • bumpversion.__main__
  • bumpversion.cli
    • @@ -205,7 +211,7 @@ -
  • Explanation