[docs]classVersionPartConfig(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]classFileConfig(BaseModel):
-"""Search and replace file config."""
-
- filename:Optional[str]=None
- glob:Optional[str]=None# Conflicts with filename. If both are specified, glob wins
- parse:Optional[str]=None# If different from outer scope
- serialize:Optional[List[str]]=None# If different from outer scope
- search:Optional[str]=None# If different from outer scope
- replace:Optional[str]=None# If different from outer scope
- regex:Optional[bool]=None# If different from outer scope
- ignore_missing_version:Optional[bool]=None
config=Config(**config_dict)# type: ignore[arg-type]# Get the information about the SCM
- tag_pattern=config.tag_name.replace("{new_version}","*")
- scm_info=get_scm_info(tag_pattern)
+ scm_info=get_scm_info(config.tag_name,config.parse)config.scm_info=scm_info# Update and verify the current_version
@@ -447,17 +319,6 @@
Source code for bumpversion.config
returnconfig
-
[docs]defget_all_part_configs(config_dict:dict)->Dict[str,VersionPartConfig]:
-"""Make sure all version parts are included."""
- serialize=config_dict["serialize"]
- parts=config_dict["parts"]
- all_labels=set(itertools.chain.from_iterable([labels_for_format(fmt)forfmtinserialize]))
- return{
- label:VersionPartConfig(**parts[label])iflabelinpartselseVersionPartConfig()# type: ignore[call-arg]
- forlabelinall_labels
- }
-
-
[docs]defcheck_current_version(config:Config)->str:""" Returns the current version.
@@ -490,221 +351,6 @@
Source code for bumpversion.config
returncurrent_versionraiseConfigurationError("Unable to determine the current version.")
-
-
-
[docs]deffind_config_file(explicit_file:Union[str,Path,None]=None)->Union[Path,None]:
-"""
- Find the configuration file, if it exists.
-
- If no explicit configuration file is passed, it will search in several files to
- find its configuration.
-
- Args:
- explicit_file: The configuration file to explicitly use.
-
- Returns:
- The configuration file path
- """
- search_paths=[Path(explicit_file)]ifexplicit_fileelseCONFIG_FILE_SEARCH_ORDER
- returnnext(
- (cfg_fileforcfg_fileinsearch_pathsifcfg_file.exists()and"bumpversion]"incfg_file.read_text()),
- None,
- )
-
-
-
[docs]defread_config_file(config_file:Union[str,Path,None]=None)->Dict[str,Any]:
-"""
- Read the configuration file, if it exists.
-
- If no explicit configuration file is passed, it will search in several files to
- find its configuration.
-
- Args:
- config_file: The configuration file to explicitly use.
-
- Returns:
- A dictionary of read key-values
- """
- ifnotconfig_file:
- logger.info("No configuration file found.")
- return{}
-
- logger.info("Reading config file %s:",config_file)
- config_path=Path(config_file)
- ifconfig_path.suffix==".cfg":
- print_warning("The .cfg file format is deprecated. Please use .toml instead.")
- returnread_ini_file(config_path)
- elifconfig_path.suffix==".toml":
- returnread_toml_file(config_path)
- return{}
-
-
-
[docs]defread_ini_file(file_path:Path)->Dict[str,Any]:# noqa: C901
-"""
- Parse an INI file and return a dictionary of sections and their options.
-
- Args:
- file_path: The path to the INI file.
-
- Returns:
- dict: A dictionary of sections and their options.
- """
- importconfigparser
-
- frombumpversionimportautocast
-
- # Create a ConfigParser object and read the INI file
- config_parser=configparser.RawConfigParser()
- iffile_path.name=="setup.cfg":
- config_parser=configparser.ConfigParser()
-
- config_parser.read(file_path)
-
- # Create an empty dictionary to hold the parsed sections and options
- bumpversion_options:Dict[str,Any]={"files":[],"parts":{}}
-
- # Loop through each section in the INI file
- forsection_nameinconfig_parser.sections():
- ifnotsection_name.startswith("bumpversion"):
- continue
-
- section_parts=section_name.split(":")
- num_parts=len(section_parts)
- options={key:autocast.autocast_value(val)forkey,valinconfig_parser.items(section_name)}
-
- ifnum_parts==1:# bumpversion section
- bumpversion_options.update(options)
- serialize=bumpversion_options.get("serialize",[])
- if"message"inbumpversion_optionsandisinstance(bumpversion_options["message"],list):
- bumpversion_options["message"]=",".join(bumpversion_options["message"])
- ifnotisinstance(serialize,list):
- bumpversion_options["serialize"]=[serialize]
- elifnum_parts>1andsection_parts[1].startswith("file"):
- file_options={
- "filename":section_parts[2],
- }
- file_options.update(options)
- if"replace"infile_optionsandisinstance(file_options["replace"],list):
- file_options["replace"]="\n".join(file_options["replace"])
- bumpversion_options["files"].append(file_options)
- elifnum_parts>1andsection_parts[1].startswith("glob"):
- file_options={
- "glob":section_parts[2],
- }
- file_options.update(options)
- if"replace"infile_optionsandisinstance(file_options["replace"],list):
- file_options["replace"]="\n".join(file_options["replace"])
- bumpversion_options["files"].append(file_options)
- elifnum_parts>1andsection_parts[1].startswith("part"):
- bumpversion_options["parts"][section_parts[2]]=options
-
- # Return the dictionary of sections and options
- returnbumpversion_options
-
-
-
[docs]defread_toml_file(file_path:Path)->Dict[str,Any]:
-"""
- Parse a TOML file and return the `bumpversion` section.
-
- Args:
- file_path: The path to the TOML file.
-
- Returns:
- dict: A dictionary of the `bumpversion` section.
- """
- importtomlkit
-
- # Load the TOML file
- toml_data=tomlkit.parse(file_path.read_text()).unwrap()
-
- returntoml_data.get("tool",{}).get("bumpversion",{})
-
-
-
[docs]defupdate_config_file(
- config_file:Union[str,Path,None],current_version:str,new_version:str,dry_run:bool=False
-)->None:
-"""
- Update the current_version key in the configuration file.
-
- If no explicit configuration file is passed, it will search in several files to
- find its configuration.
-
- Instead of parsing and re-writing the config file with new information, it will use
- a regular expression to just replace the current_version value. The idea is it will
- avoid unintentional changes (like formatting) to the config file.
-
- Args:
- config_file: The configuration file to explicitly use.
- current_version: The serialized current version.
- new_version: The serialized new version.
- dry_run: True if the update should be a dry run.
- """
- toml_current_version_regex=re.compile(
- f'(?P<section_prefix>\\[tool\\.bumpversion]\n[^[]*current_version\\s*=\\s*)(\\"{current_version}\\")',
- re.MULTILINE,
- )
- cfg_current_version_regex=re.compile(
- f"(?P<section_prefix>\\[bumpversion]\n[^[]*current_version\\s*=\\s*)(?P<version>{current_version})",
- re.MULTILINE,
- )
-
- ifnotconfig_file:
- logger.info("No configuration file found to update.")
- return
-
- config_path=Path(config_file)
- existing_config=config_path.read_text()
- ifconfig_path.suffix==".cfg"andcfg_current_version_regex.search(existing_config):
- sub_str=f"\\g<section_prefix>{new_version}"
- new_config=cfg_current_version_regex.sub(sub_str,existing_config)
- elifconfig_path.suffix==".toml"andtoml_current_version_regex.search(existing_config):
- sub_str=f'\\g<section_prefix>"{new_version}"'
- new_config=toml_current_version_regex.sub(sub_str,existing_config)
- else:
- logger.info("Could not find the current version in the config file: %s.",config_path)
- return
-
- logger.info(
- "%s to config file %s:",
- "Would write"ifdry_runelse"Writing",
- config_path,
- )
-
- logger.info(
- "\n".join(
- list(
- context_diff(
- existing_config.splitlines(),
- new_config.splitlines(),
- fromfile=f"before {config_path}",
- tofile=f"after {config_path}",
- lineterm="",
- )
- )
- )
- )
-
- ifnotdry_run:
- config_path.write_text(new_config)
-
-
-
[docs]defget_glob_files(file_cfg:FileConfig)->List[FileConfig]:
-"""
- Return a list of files that match the glob pattern.
-
- Args:
- file_cfg: The file configuration containing the glob pattern
-
- Returns:
- A list of resolved file configurations according to the pattern.
- """
- files=[]
- forfilename_globinglob.glob(file_cfg.glob,recursive=True):
- new_file_cfg=file_cfg.copy()
- new_file_cfg.filename=filename_glob
- new_file_cfg.glob=None
- files.append(new_file_cfg)
- returnfiles
[docs]deffind_config_file(explicit_file:Union[str,Path,None]=None)->Union[Path,None]:
+"""
+ Find the configuration file, if it exists.
+
+ If no explicit configuration file is passed, it will search in several files to
+ find its configuration.
+
+ Args:
+ explicit_file: The configuration file to explicitly use.
+
+ Returns:
+ The configuration file path
+ """
+ search_paths=[Path(explicit_file)]ifexplicit_fileelseCONFIG_FILE_SEARCH_ORDER
+ returnnext(
+ (cfg_fileforcfg_fileinsearch_pathsifcfg_file.exists()and"bumpversion]"incfg_file.read_text()),
+ None,
+ )
+
+
+
[docs]defread_config_file(config_file:Union[str,Path,None]=None)->Dict[str,Any]:
+"""
+ Read the configuration file, if it exists.
+
+ If no explicit configuration file is passed, it will search in several files to
+ find its configuration.
+
+ Args:
+ config_file: The configuration file to explicitly use.
+
+ Returns:
+ A dictionary of read key-values
+ """
+ ifnotconfig_file:
+ logger.info("No configuration file found.")
+ return{}
+
+ logger.info("Reading config file %s:",config_file)
+ config_path=Path(config_file)
+ ifconfig_path.suffix==".cfg":
+ print_warning("The .cfg file format is deprecated. Please use .toml instead.")
+ returnread_ini_file(config_path)
+ elifconfig_path.suffix==".toml":
+ returnread_toml_file(config_path)
+ return{}
+
+
+
[docs]defread_ini_file(file_path:Path)->Dict[str,Any]:# noqa: C901
+"""
+ Parse an INI file and return a dictionary of sections and their options.
+
+ Args:
+ file_path: The path to the INI file.
+
+ Returns:
+ dict: A dictionary of sections and their options.
+ """
+ importconfigparser
+
+ frombumpversionimportautocast
+
+ # Create a ConfigParser object and read the INI file
+ config_parser=configparser.RawConfigParser()
+ iffile_path.name=="setup.cfg":
+ config_parser=configparser.ConfigParser()
+
+ config_parser.read(file_path)
+
+ # Create an empty dictionary to hold the parsed sections and options
+ bumpversion_options:Dict[str,Any]={"files":[],"parts":{}}
+
+ # Loop through each section in the INI file
+ forsection_nameinconfig_parser.sections():
+ ifnotsection_name.startswith("bumpversion"):
+ continue
+
+ section_parts=section_name.split(":")
+ num_parts=len(section_parts)
+ options={key:autocast.autocast_value(val)forkey,valinconfig_parser.items(section_name)}
+
+ ifnum_parts==1:# bumpversion section
+ bumpversion_options.update(options)
+ serialize=bumpversion_options.get("serialize",[])
+ if"message"inbumpversion_optionsandisinstance(bumpversion_options["message"],list):
+ bumpversion_options["message"]=",".join(bumpversion_options["message"])
+ ifnotisinstance(serialize,list):
+ bumpversion_options["serialize"]=[serialize]
+ elifnum_parts>1andsection_parts[1].startswith("file"):
+ file_options={
+ "filename":section_parts[2],
+ }
+ file_options.update(options)
+ if"replace"infile_optionsandisinstance(file_options["replace"],list):
+ file_options["replace"]="\n".join(file_options["replace"])
+ bumpversion_options["files"].append(file_options)
+ elifnum_parts>1andsection_parts[1].startswith("glob"):
+ file_options={
+ "glob":section_parts[2],
+ }
+ file_options.update(options)
+ if"replace"infile_optionsandisinstance(file_options["replace"],list):
+ file_options["replace"]="\n".join(file_options["replace"])
+ bumpversion_options["files"].append(file_options)
+ elifnum_parts>1andsection_parts[1].startswith("part"):
+ bumpversion_options["parts"][section_parts[2]]=options
+
+ # Return the dictionary of sections and options
+ returnbumpversion_options
+
+
+
[docs]defread_toml_file(file_path:Path)->Dict[str,Any]:
+"""
+ Parse a TOML file and return the `bumpversion` section.
+
+ Args:
+ file_path: The path to the TOML file.
+
+ Returns:
+ dict: A dictionary of the `bumpversion` section.
+ """
+ importtomlkit
+
+ # Load the TOML file
+ toml_data=tomlkit.parse(file_path.read_text()).unwrap()
+
+ returntoml_data.get("tool",{}).get("bumpversion",{})
+
+
+
[docs]defupdate_config_file(
+ config_file:Union[str,Path],
+ config:Config,
+ current_version:Version,
+ new_version:Version,
+ context:MutableMapping,
+ dry_run:bool=False,
+)->None:
+"""
+ Update the current_version key in the configuration file.
+
+ Args:
+ config_file: The configuration file to explicitly use.
+ config: The configuration to use.
+ current_version: The current version.
+ new_version: The new version.
+ context: The context to use for serialization.
+ dry_run: True if the update should be a dry run.
+ """
+ frombumpversion.config.modelsimportFileConfig
+ frombumpversion.filesimportDataFileUpdater
+
+ ifnotconfig_file:
+ logger.info("No configuration file found to update.")
+ return
+
+ config_path=Path(config_file)
+ ifconfig_path.suffix!=".toml":
+ logger.info("Could not find the current version in the config file: %s.",config_path)
+ return
+
+ # TODO: Eventually this should be transformed into another default "files_to_modify" entry
+ datafile_config=FileConfig(
+ filename=str(config_path),
+ key_path="tool.bumpversion.current_version",
+ search=config.search,
+ replace=config.replace,
+ regex=config.regex,
+ ignore_missing_version=config.ignore_missing_version,
+ serialize=config.serialize,
+ parse=config.parse,
+ )
+
+ updater=DataFileUpdater(datafile_config,config.version_config.part_configs)
+ updater.update_file(current_version,new_version,context,dry_run)
+
+
+
[docs]defupdate_ini_config_file(
+ config_file:Union[str,Path],current_version:str,new_version:str,dry_run:bool=False
+)->None:
+"""
+ Update the current_version key in the configuration file.
+
+ Instead of parsing and re-writing the config file with new information, it will use
+ a regular expression to just replace the current_version value. The idea is it will
+ avoid unintentional changes (like formatting) to the config file.
+
+ Args:
+ config_file: The configuration file to explicitly use.
+ current_version: The serialized current version.
+ new_version: The serialized new version.
+ dry_run: True if the update should be a dry run.
+ """
+ cfg_current_version_regex=re.compile(
+ f"(?P<section_prefix>\\[bumpversion]\n[^[]*current_version\\s*=\\s*)(?P<version>{current_version})",
+ re.MULTILINE,
+ )
+
+ config_path=Path(config_file)
+ existing_config=config_path.read_text()
+ ifconfig_path.suffix==".cfg"andcfg_current_version_regex.search(existing_config):
+ sub_str=f"\\g<section_prefix>{new_version}"
+ new_config=cfg_current_version_regex.sub(sub_str,existing_config)
+ else:
+ logger.info("Could not find the current version in the config file: %s.",config_path)
+ return
+
+ logger.info(
+ "%s to config file %s:",
+ "Would write"ifdry_runelse"Writing",
+ config_path,
+ )
+
+ logger.info(
+ "\n".join(
+ list(
+ context_diff(
+ existing_config.splitlines(),
+ new_config.splitlines(),
+ fromfile=f"before {config_path}",
+ tofile=f"after {config_path}",
+ lineterm="",
+ )
+ )
+ )
+ )
+
+ ifnotdry_run:
+ config_path.write_text(new_config)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/_modules/bumpversion/config/models.html b/_modules/bumpversion/config/models.html
new file mode 100644
index 00000000..c726daff
--- /dev/null
+++ b/_modules/bumpversion/config/models.html
@@ -0,0 +1,401 @@
+
+
+
+
+
+
+
+ bumpversion.config.models - Bump My Version 0.12.0
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+"""Bump My Version configuration models."""
+from__future__importannotations
+
+fromtypingimportTYPE_CHECKING,Dict,List,Optional,Union
+
+frompydanticimportBaseModel,Field
+frompydantic_settingsimportBaseSettings,SettingsConfigDict
+
+ifTYPE_CHECKING:
+ frombumpversion.scmimportSCMInfo
+ frombumpversion.version_partimportVersionConfig
+
+
+
[docs]classVersionPartConfig(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]classFileConfig(BaseModel):
+"""Search and replace file config."""
+
+ parse:str
+ serialize:List[str]
+ search:str
+ replace:str
+ regex:bool
+ ignore_missing_version:bool
+ filename:Optional[str]=None
+ glob:Optional[str]=None# Conflicts with filename. If both are specified, glob wins
+ key_path:Optional[str]=None# If specified, and has an appropriate extension, will be treated as a data file
+"""Helper functions for the config module."""
+from__future__importannotations
+
+importglob
+importitertools
+fromtypingimportDict,List
+
+frombumpversion.config.modelsimportFileConfig,VersionPartConfig
+frombumpversion.utilsimportlabels_for_format
+
+
+
[docs]defget_all_file_configs(config_dict:dict)->List[FileConfig]:
+"""Make sure all version parts are included."""
+ defaults={
+ "parse":config_dict["parse"],
+ "serialize":config_dict["serialize"],
+ "search":config_dict["search"],
+ "replace":config_dict["replace"],
+ "ignore_missing_version":config_dict["ignore_missing_version"],
+ "regex":config_dict["regex"],
+ }
+ files=[{k:vfork,vinfilecfg.items()ifvisnotNone}forfilecfginconfig_dict["files"]]
+ forfinfiles:
+ f.update({k:vfork,vindefaults.items()ifknotinf})
+ return[FileConfig(**f)forfinfiles]
+
+
+
[docs]defget_all_part_configs(config_dict:dict)->Dict[str,VersionPartConfig]:
+"""Make sure all version parts are included."""
+ serialize=config_dict["serialize"]
+ parts=config_dict["parts"]
+ all_labels=set(itertools.chain.from_iterable([labels_for_format(fmt)forfmtinserialize]))
+ return{
+ label:VersionPartConfig(**parts[label])iflabelinpartselseVersionPartConfig()# type: ignore[call-arg]
+ forlabelinall_labels
+ }
+
+
+
[docs]defresolve_glob_files(file_cfg:FileConfig)->List[FileConfig]:
+"""
+ Return a list of file configurations that match the glob pattern.
+
+ Args:
+ file_cfg: The file configuration containing the glob pattern
+
+ Returns:
+ A list of resolved file configurations according to the pattern.
+ """
+ files=[]
+ forfilename_globinglob.glob(file_cfg.glob,recursive=True):
+ new_file_cfg=file_cfg.model_copy()
+ new_file_cfg.filename=filename_glob
+ new_file_cfg.glob=None
+ files.append(new_file_cfg)
+ returnfiles
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/_modules/bumpversion/exceptions.html b/_modules/bumpversion/exceptions.html
index d5182c0d..78e81874 100644
--- a/_modules/bumpversion/exceptions.html
+++ b/_modules/bumpversion/exceptions.html
@@ -176,27 +176,31 @@
[docs]defget_search_pattern(search_str:str,context:MutableMapping,use_regex:bool=False)->Tuple[re.Pattern,str]:
+"""
+ Render the search pattern and return the compiled regex pattern and the raw pattern.
+
+ Args:
+ search_str: A string containing the search pattern as a format string
+ context: The context to use for rendering the search pattern
+ use_regex: If True, the search pattern is treated as a regex pattern
+
+ Returns:
+ A tuple of the compiled regex pattern and the raw pattern as a string.
+ """
+ # the default search pattern is escaped, so we can still use it in a regex
+ raw_pattern=search_str.format(**context)
+ default=re.compile(re.escape(raw_pattern),re.MULTILINE|re.DOTALL)
+ ifnotuse_regex:
+ logger.debug("No RegEx flag detected. Searching for the default pattern: '%s'",default.pattern)
+ returndefault,raw_pattern
+
+ re_context={key:re.escape(str(value))forkey,valueincontext.items()}
+ regex_pattern=search_str.format(**re_context)
+ try:
+ search_for_re=re.compile(regex_pattern,re.MULTILINE|re.DOTALL)
+ logger.debug("Searching for the regex: '%s'",search_for_re.pattern)
+ returnsearch_for_re,raw_pattern
+ exceptre.errorase:
+ logger.error("Invalid regex '%s': %s.",default,e)
+
+ logger.debug("Invalid regex. Searching for the default pattern: '%s'",raw_pattern)
+ returndefault,raw_pattern
+
+
+
[docs]defcontains_pattern(search:re.Pattern,contents:str)->bool:
+"""Does the search pattern match any part of the contents?"""
+ ifnotsearchornotcontents:
+ returnFalse
+
+ forminre.finditer(search,contents):
+ line_no=contents.count("\n",0,m.start(0))+1
+ logger.info(
+ "Found '%s' at line %s: %s",
+ search,
+ line_no,
+ m.string[m.start():m.end(0)],
+ )
+ returnTrue
+ returnFalse
+
+
+
[docs]deflog_changes(file_path:str,file_content_before:str,file_content_after:str,dry_run:bool=False)->None:
+"""
+ Log the changes that would be made to the file.
+
+ Args:
+ file_path: The path to the file
+ file_content_before: The file contents before the change
+ file_content_after: The file contents after the change
+ dry_run: True if this is a report-only job
+ """
+ iffile_content_before!=file_content_after:
+ logger.info("%s file %s:","Would change"ifdry_runelse"Changing",file_path)
+ logger.info(
+ "\n".join(
+ list(
+ context_diff(
+ file_content_before.splitlines(),
+ file_content_after.splitlines(),
+ fromfile=f"before {file_path}",
+ tofile=f"after {file_path}",
+ lineterm="",
+ )
+ )
+ )
+ )
+ else:
+ logger.info("%s file %s","Would not change"ifdry_runelse"Not changing",file_path)
+
+
[docs]classConfiguredFile:"""A file to modify in a configured way."""
@@ -300,9 +383,9 @@
Source code for bumpversion.files
Returns: True if the version number is in fact present. """
- search_expression,raw_search_expression=self.get_search_pattern(context)
-
- ifself.contains(search_expression):
+ search_expression,raw_search_expression=get_search_pattern(self.search,context,self.regex)
+ file_contents=self.get_file_contents()
+ ifcontains_pattern(search_expression,file_contents):returnTrue# the `search` pattern did not match, but the original supplied
@@ -313,7 +396,7 @@
Source code for bumpversion.files
# very specific parts of the filesearch_pattern_is_default=self.search==self.version_config.search
- ifsearch_pattern_is_defaultandself.contains(re.compile(re.escape(version.original))):
+ ifsearch_pattern_is_defaultandcontains_pattern(re.compile(re.escape(version.original)),file_contents):# The original version is present, and we're not looking for something# more specific -> this is accepted as a matchreturnTrue
@@ -323,25 +406,6 @@
Source code for bumpversion.files
returnFalseraiseVersionNotFoundError(f"Did not find '{raw_search_expression}' in file: '{self.path}'")
-
[docs]defcontains(self,search:re.Pattern)->bool:
-"""Does the work of the contains_version method."""
- ifnotsearch:
- returnFalse
-
- contents=self.get_file_contents()
-
- forminre.finditer(search,contents):
- line_no=contents.count("\n",0,m.start(0))+1
- logger.info(
- "Found '%s' in %s at line %s: %s",
- search,
- self.path,
- line_no,
- m.string[m.start():m.end(0)],
- )
- returnTrue
- returnFalse
[docs]defget_search_pattern(self,context:MutableMapping)->Tuple[re.Pattern,str]:
-"""Compile and return the regex if it is valid, otherwise return the string."""
- # the default search pattern is escaped, so we can still use it in a regex
- raw_pattern=self.version_config.search.format(**context)
- default=re.compile(re.escape(raw_pattern),re.MULTILINE|re.DOTALL)
- ifnotself.regex:
- logger.debug("No RegEx flag detected. Searching for the default pattern: '%s'",default.pattern)
- returndefault,raw_pattern
-
- re_context={key:re.escape(str(value))forkey,valueincontext.items()}
- regex_pattern=self.version_config.search.format(**re_context)
- try:
- search_for_re=re.compile(regex_pattern,re.MULTILINE|re.DOTALL)
- logger.debug("Searching for the regex: '%s'",search_for_re.pattern)
- returnsearch_for_re,raw_pattern
- exceptre.errorase:
- logger.error("Invalid regex '%s' for file %s: %s.",default,self.path,e)
-
- logger.debug("Searching for the default pattern: '%s'",raw_pattern)
- returndefault,raw_pattern
[docs]@classmethod
- deflatest_tag_info(cls,tag_pattern:str)->SCMInfo:
+ deflatest_tag_info(cls,tag_name:str,parse_pattern:str)->SCMInfo:"""Return information about the latest tag."""raiseNotImplementedError()
raiseDirtyWorkingDirectoryError(f"Git working directory is not clean:\n\n{joined_lines}")
[docs]@classmethod
- deflatest_tag_info(cls,tag_pattern:str)->SCMInfo:
+ deflatest_tag_info(cls,tag_name:str,parse_pattern:str)->SCMInfo:"""Return information about the latest tag."""try:# git-describe doesn't update the git-index, so we do that
@@ -464,7 +479,7 @@
Source code for bumpversion.scm
exceptsubprocess.CalledProcessErrorase:logger.debug("Error when running git update-index: %s",e.stderr)returnSCMInfo(tool=cls)
-
+ tag_pattern=tag_name.replace("{new_version}","*")try:# get info about the latest tag in gitgit_cmd=[
@@ -497,7 +512,8 @@
[docs]defextract_regex_flags(regex_pattern:str)->Tuple[str,str]:
+"""
+ Extract the regex flags from the regex pattern.
+
+ Args:
+ regex_pattern: The pattern that might start with regex flags
+
+ Returns:
+ A tuple of the regex pattern without the flag string and regex flag string
+ """
+ importre
+
+ flag_pattern=r"^(\(\?[aiLmsux]+\))"
+ bits=re.split(flag_pattern,regex_pattern)
+ return(regex_pattern,"")iflen(bits)==1else(bits[2],bits[1])
[docs]defkey_val_string(d:dict)->str:"""Render the dictionary as a comma-delimited key=value string."""return", ".join(f"{k}={v}"fork,vinsorted(d.items()))
self.serialize_formats=serializeself.part_configs=part_configsor{}
+ # TODO: I think these two should be removed from the config objectself.search=searchself.replace=replace
diff --git a/_modules/bumpversion/yaml_dump.html b/_modules/bumpversion/yaml_dump.html
index f5e17715..431e4a34 100644
--- a/_modules/bumpversion/yaml_dump.html
+++ b/_modules/bumpversion/yaml_dump.html
@@ -176,27 +176,31 @@
Update the current_version key in the configuration file.
-
If no explicit configuration file is passed, it will search in several files to
-find its configuration.
-
Instead of parsing and re-writing the config file with new information, it will use
-a regular expression to just replace the current_version value. The idea is it will
-avoid unintentional changes (like formatting) to the config file.
-
Args:
-config_file: The configuration file to explicitly use.
-current_version: The serialized current version.
-new_version: The serialized new version.
-dry_run: True if the update should be a dry run.
Render the search pattern and return the compiled regex pattern and the raw pattern.
+
Args:
+search_str: A string containing the search pattern as a format string
+context: The context to use for rendering the search pattern
+use_regex: If True, the search pattern is treated as a regex pattern
+
Returns:
+A tuple of the compiled regex pattern and the raw pattern as a string.
Args:
+file_path: The path to the file
+file_content_before: The file contents before the change
+file_content_after: The file contents after the change
+dry_run: True if this is a report-only job