update_version.ReplacementRule Class Reference

Public Member Functions
def	__init__ (self, Union[str, re.Pattern] pattern, Union[str, Callable[[str, Fields], str]] replace)
str	__call__ (self, str line, Fields fields)

Public Attributes
	pattern
	replace

Detailed Description

Helper to replace lines with patterns or applying functions.

>>> r = ReplacementRule(r"^version: ", "version: {cmake_version}")
>>> f = Fields("v1r1", datetime.date(2023, 9, 25))
>>> r("nothing to change\\n", f)
'nothing to change\\n'
>>> r("version: 1.0\\n", f)
'version: 1.1\\n'

Definition at line 72 of file update_version.py.

Constructor & Destructor Documentation

__init__()

def update_version.ReplacementRule.__init__	(		self,
		Union[str, re.Pattern]	pattern,
		Union[str, Callable[[str, Fields], str]]	replace
	)

Definition at line 84 of file update_version.py.

    def __init__(
        self,
        pattern: Union[str, re.Pattern],
        replace: Union[str, Callable[[str, Fields], str]],
    ):
        self.pattern = re.compile(pattern)
        if isinstance(replace, str):
            replace = f"{replace.rstrip()}\n"
            self.replace = lambda _line, fields: replace.format(**fields.data)
        else:
            self.replace = replace
 

Member Function Documentation

__call__()

str update_version.ReplacementRule.__call__	(		self,
		str	line,
		Fields	fields
	)

Definition at line 96 of file update_version.py.

    def __call__(self, line: str, fields: Fields) -> str:
        if self.pattern.match(line):
            return self.replace(line, fields)
        return line
 
 

Member Data Documentation

pattern

update_version.ReplacementRule.pattern

Definition at line 85 of file update_version.py.

replace

update_version.ReplacementRule.replace

Definition at line 88 of file update_version.py.

---

The documentation for this class was generated from the following file:

• utils/update_version.py