ats_utilities.info.info_keys module

Module

info_keys.py

Copyright

Copyright (C) 2017 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com> ats_utilities is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. ats_utilities is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Info

Defines class InfoKeys with attribute(s). Defines constants for information keys.

class ats_utilities.info.info_keys.InfoKeys[source]

Bases: object

Defines class InfoKeys with attribute(s). Defines constants for information keys. The information keys are used for information container. The information container store data for App/Tool/Script.

It defines:

attributes:
ATS_NAME - The key for name.
ATS_VERSION - The key for version.
ATS_BUILD_DATE - The key for build date.
ATS_LICENCE - The key for licence.
ATS_REPOSITORY - The key for repository.
ATS_ORGANIZATION - The key for organization.
ATS_USE_GITHUB_INFRASTRUCTURE - The key for use github infrastructure.
ATS_LOGO_PATH - The key for logo path.
ATS_BUILD_DATE: ClassVar[str] = 'ats_build_date'
ATS_LICENCE: ClassVar[str] = 'ats_licence'
ATS_LOGO_PATH: ClassVar[str] = 'ats_logo_path'
ATS_NAME: ClassVar[str] = 'ats_name'
ATS_ORGANIZATION: ClassVar[str] = 'ats_organization'
ATS_REPOSITORY: ClassVar[str] = 'ats_repository'
ATS_USE_GITHUB_INFRASTRUCTURE: ClassVar[str] = 'ats_use_github_infrastructure'
ATS_VERSION: ClassVar[str] = 'ats_version'
classmethod get_key_to_attr() → MappingProxyType[source]

Returns a mapping of information keys to attributes.

Returns:

Key to attribute mapping.

Return type:

<MappingProxyType[str, str]>

Exceptions:

None.

classmethod get_keys() → tuple[str, ...][source]

Returns a tuple of all information keys.

Returns:

Tuple of all keys.

Return type:

<tuple[str, …]>

Exceptions:

None.