ToolDetails#

class caf.toolkit.log_helpers.ToolDetails(name, version, homepage=None, source_url=None)#

Bases: object

Information about the current tool.

Parameters:

  • name (str)

  • version (Annotated[str, StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$)])

  • homepage (Annotated[Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)] | None)

  • source_url (Annotated[Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)] | None)

name#

Name of the tool.

Type:

str

version#

Version of the tool, should be in semantic versioning format https://semver.org/.

Type:

str

homepage#

URL of the homepage for the tool.

Type:

str, optional

source_url#

URL of the source code repository for the tool.

Type:

str, optional

Attributes

homepage

source_url

name

version

Methods

__init__(*args, **kwargs)

Attributes Documentation

homepage: Annotated[Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)] | None = None#
source_url: Annotated[Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)] | None = None#
name: str#
version: [0-9a-zA-Z-]+)*))?$)]#