Skip to content

Package API

Back to API Reference

The version of the installed commol and the commit it was built from. Save them with a result to name the code that made it. Guide: Check the installation.

commol.__version__ is the PEP 440 version, the same as build_info().version: the version of a release, or the placeholder version with the commit as a local version (0.1.0+g<first 7 characters of the commit>) for a build that is not a release.

Commol logs to the logger commol and its children, and adds only a logging.NullHandler. Your application chooses where the messages go. Guide: Log messages.

build_info 

build_info() -> BuildInfo

Return the version of the installed commol and the commit it was built from.

Save it with a result to name the code that made it.

Returns:

Type Description
BuildInfo

The version and the full commit, read when the extension was built.
Source code in commol/api/build_info.py 
35
36
37
38
39
40
41
42
43
44
45
46
def build_info() -> BuildInfo:
    """
    Return the version of the installed commol and the commit it was built from.

    Save it with a result to name the code that made it.

    Returns
    -------
    BuildInfo
        The version and the full commit, read when the extension was built.
    """
    return BuildInfo(version=_commol_rs.__version__, commit=_commol_rs.__commit__)

BuildInfo

Bases: BaseModel

The version of the installed commol and the commit it was built from.

Attributes:

Name Type Description
version str

The PEP 440 version, the one commol.__version__ gives. A release gives its version, such as "0.9.0". A build that is not a release, such as an install from a git commit or an editable install, gives the placeholder version of the source with the commit as a local version, such as "0.1.0+g0123abc".
commit str | None

The full hash of the git commit of the source, or None when the source has no git metadata, such as a source distribution.
Source code in commol/api/build_info.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class BuildInfo(BaseModel):
    """
    The version of the installed commol and the commit it was built from.

    Attributes
    ----------
    version : str
        The PEP 440 version, the one `commol.__version__` gives. A release
        gives its version, such as ``"0.9.0"``. A build that is not a release,
        such as an install from a git commit or an editable install, gives the
        placeholder version of the source with the commit as a local version,
        such as ``"0.1.0+g0123abc"``.
    commit : str | None
        The full hash of the git commit of the source, or None when the source
        has no git metadata, such as a source distribution.
    """

    model_config = ConfigDict(extra="forbid", frozen=True)

    version: str
    commit: str | None