update_version.FileUpdater Class Reference

Public Member Functions
def	__init__ (self, str filename, Iterable[Union[ReplacementRule, tuple[str, str]]] rules)
tuple[str, list[str], list[str]]	__call__ (self, Fields fields)

Public Attributes
	filename
	rules

Private Member Functions
str	_apply_rules (self, str line, Fields fields)

Detailed Description

Definition at line 99 of file update_version.py.

Constructor & Destructor Documentation

__init__()

def update_version.FileUpdater.__init__	(		self,
		str	filename,
		Iterable[Union[ReplacementRule, tuple[str, str]]]	rules
	)

Definition at line 100 of file update_version.py.

    def __init__(
        self, filename: str, rules: Iterable[Union[ReplacementRule, tuple[str, str]]]
    ):
        self.filename = filename
        self.rules = [
            r if isinstance(r, ReplacementRule) else ReplacementRule(*r) for r in rules
        ]
 

Member Function Documentation

__call__()

tuple[str, list[str], list[str]] update_version.FileUpdater.__call__	(		self,
		Fields	fields
	)

Definition at line 113 of file update_version.py.

    def __call__(self, fields: Fields) -> tuple[str, list[str], list[str]]:
        with open(self.filename) as f:
            old = f.readlines()
        return self.filename, old, [self._apply_rules(line, fields) for line in old]
 
 

_apply_rules()

str update_version.FileUpdater._apply_rules (   self, str  line, Fields  fields  )

private

Definition at line 108 of file update_version.py.

    def _apply_rules(self, line: str, fields: Fields) -> str:
        for rule in self.rules:
            line = rule(line, fields)
        return line
 

Member Data Documentation

filename

update_version.FileUpdater.filename

Definition at line 101 of file update_version.py.

rules

update_version.FileUpdater.rules

Definition at line 102 of file update_version.py.

---

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

• utils/update_version.py