utils

Repository management tasks powered by invoke. More information on invoke can be found at pyinvoke.org.

Emoji (str, Enum)

Unicode strings for certain emojis.

Source code in ci_cd/utils.py

class Emoji(str, Enum):
    """Unicode strings for certain emojis."""

    PARTY_POPPER = "\U0001f389"
    CHECK_MARK = "\u2714"
    CROSS_MARK = "\u274c"
    CURLY_LOOP = "\u27b0"

SemanticVersion

A semantic version.

See SemVer.org for more information about semantic versioning.

The semantic version is in this invocation considered to build up in the following way:

<major>.<minor>.<patch>-<pre_release>+<build>

Where the names in carets are callable attributes for the instance.

When casting instances of SemanticVersion to str, the full version will be returned, i.e., as shown above, with a minimum of major.minor.patch.

For example, for the version 1.5, i.e., major=1, minor=5, the returned str representation will be the full major.minor.patch version: 1.5.0. The patch attribute will default to 0 while pre_release and build will be None, when asked for explicitly.

Parameters:

Name	Type	Description	Default
major	Union[str, int]	The major version.	required
minor	Optional[Union[str, int]]	The minor version.	None
patch	Optional[Union[str, int]]	The patch version.	None
pre_release	Optional[str]	The pre-release part of the version, i.e., the part supplied after a minus (-), but before a plus (+).	None
build	Optional[str]	The build metadata part of the version, i.e., the part supplied at the end of the version, after a plus (+).	None

Attributes:

Name	Type	Description
major	int	The major version.
minor	int	The minor version.
patch	int	The patch version.
pre_release	str	The pre-release part of the version, i.e., the part supplied after a minus (-), but before a plus (+).
build	str	The build metadata part of the version, i.e., the part supplied at the end of the version, after a plus (+).

Source code in ci_cd/utils.py

class SemanticVersion:
    """A semantic version.

    See [SemVer.org](https://semver.org) for more information about semantic
    versioning.

    The semantic version is in this invocation considered to build up in the following
    way:

        <major>.<minor>.<patch>-<pre_release>+<build>

    Where the names in carets are callable attributes for the instance.

    When casting instances of `SemanticVersion` to `str`, the full version will be
    returned, i.e., as shown above, with a minimum of major.minor.patch.

    For example, for the version `1.5`, i.e., `major=1, minor=5`, the returned `str`
    representation will be the full major.minor.patch version: `1.5.0`.
    The `patch` attribute will default to `0` while `pre_release` and `build` will be
    `None`, when asked for explicitly.

    Parameters:
        major (Union[str, int]): The major version.
        minor (Optional[Union[str, int]]): The minor version.
        patch (Optional[Union[str, int]]): The patch version.
        pre_release (Optional[str]): The pre-release part of the version, i.e., the
            part supplied after a minus (`-`), but before a plus (`+`).
        build (Optional[str]): The build metadata part of the version, i.e., the part
            supplied at the end of the version, after a plus (`+`).

    Attributes:
        major (int): The major version.
        minor (int): The minor version.
        patch (int): The patch version.
        pre_release (str): The pre-release part of the version, i.e., the part
            supplied after a minus (`-`), but before a plus (`+`).
        build (str): The build metadata part of the version, i.e., the part supplied at
            the end of the version, after a plus (`+`).

    """

    def __init__(
        self,
        major: "Union[str, int]",
        minor: "Optional[Union[str, int]]" = None,
        patch: "Optional[Union[str, int]]" = None,
        pre_release: "Optional[str]" = None,
        build: "Optional[str]" = None,
    ) -> None:
        self._major = int(major)
        self._minor = int(minor) if minor else 0
        self._patch = int(patch) if patch else 0
        self._pre_release = pre_release if pre_release else None
        self._build = build if build else None

    @property
    def major(self) -> int:
        """The major version."""
        return self._major

    @property
    def minor(self) -> int:
        """The minor version."""
        return self._minor

    @property
    def patch(self) -> int:
        """The patch version."""
        return self._patch

    @property
    def pre_release(self) -> "Union[None, str]":
        """The pre-release part of the version

        This is the part supplied after a minus (`-`), but before a plus (`+`).
        """
        return self._pre_release

    @property
    def build(self) -> "Union[None, str]":
        """The build metadata part of the version.

        This is the part supplied at the end of the version, after a plus (`+`).
        """
        return self._build

    def __str__(self) -> str:
        """Return the full version."""
        return (
            f"{self.major}.{self.minor}.{self.patch}"
            f"{f'-{self.pre_release}' if self.pre_release else ''}"
            f"{f'+{self.build}' if self.build else ''}"
        )

    def __repr__(self) -> str:
        """Return the string representation of the object."""
        return repr(self.__str__())

build: Union[None, str] property readonly

The build metadata part of the version.

This is the part supplied at the end of the version, after a plus (+).

major: int property readonly

The major version.

minor: int property readonly

The minor version.

patch: int property readonly

The patch version.

pre_release: Union[None, str] property readonly

The pre-release part of the version

This is the part supplied after a minus (-), but before a plus (+).

__repr__(self) special

Return the string representation of the object.

Source code in ci_cd/utils.py

def __repr__(self) -> str:
    """Return the string representation of the object."""
    return repr(self.__str__())

__str__(self) special

Return the full version.

Source code in ci_cd/utils.py

def __str__(self) -> str:
    """Return the full version."""
    return (
        f"{self.major}.{self.minor}.{self.patch}"
        f"{f'-{self.pre_release}' if self.pre_release else ''}"
        f"{f'+{self.build}' if self.build else ''}"
    )

update_file(filename, sub_line, strip=None)

Utility function for tasks to read, update, and write files

Source code in ci_cd/utils.py

def update_file(
    filename: Path, sub_line: "Tuple[str, str]", strip: "Optional[str]" = None
) -> None:
    """Utility function for tasks to read, update, and write files"""
    if strip is None and filename.suffix == ".md":
        # Keep special white space endings for markdown files
        strip = "\n"
    lines = [
        re.sub(sub_line[0], sub_line[1], line.rstrip(strip))
        for line in filename.read_text(encoding="utf8").splitlines()
    ]
    filename.write_text("\n".join(lines) + "\n", encoding="utf8")