onyo.lib.consts module

onyo.lib.consts.ANCHOR_FILE_NAME = '.anchor'

Name of the empty file created in all directories to “anchor” them.

This is necessary because git only tracks files and not directories.

onyo.lib.consts.ASSET_DIR_FILE_NAME = '.onyo-asset-dir'

Name of the file that asset-content is stored in for Asset Directories.

onyo.lib.consts.IGNORE_FILE_NAME = '.onyoignore'

Name of the file that is Onyo’s version of Git’s .gitignore file.

onyo.lib.consts.KNOWN_REPO_VERSIONS = ['1', '2']

Onyo repository versions that this onyo version knows about.

Use for backwards compatibility, upgrades, and detecting repositories created by a newer version.

onyo.lib.consts.ONYO_CONFIG = PosixPath('.onyo/config')

Path of the Onyo config file.

onyo.lib.consts.ONYO_DIR = PosixPath('.onyo')

The Path of the “dot onyo” directory that contains the onyo configuration, templates, etc.

onyo.lib.consts.RESERVED_KEYS = ['template', 'onyo', 'path', 'directory']

Reserved key names that must not be part of asset content.

These keys have functional meaning for Onyo. They are reserved and cannot be part of asset content.

onyo.lib.consts.SORT_ASCENDING = 'ascending'

Sort ascending.

Use to sort the output of onyo_get().

onyo.lib.consts.SORT_DESCENDING = 'descending'

Sort descending.

Use to sort the output of onyo_get().

onyo.lib.consts.TAG_BOOL = '<bool>'

Tag symbol for keys with a boolean as the value.

Use for type matching (onyo_get()).

onyo.lib.consts.TAG_DICT = '<dict>'

Tag symbol for keys with a dict as the value.

Use for type matching (onyo_get()) and output.

onyo.lib.consts.TAG_EMPTY = '<empty>'

Tag symbol for keys set to null or are an empty string, dictionary, or list.

Use for type matching (onyo_get()).

onyo.lib.consts.TAG_FALSE = '<false>'

Tag symbol for keys with False as the value.

Use for type matching (onyo_get()).

onyo.lib.consts.TAG_LIST = '<list>'

Tag symbol for keys with a list as the value.

Use for type matching (onyo_get()) and output.

onyo.lib.consts.TAG_MAP_OUTPUT = {'<dict>': (<class 'dict'>, <class 'collections.UserDict'>), '<list>': <class 'list'>, '<null>': <class 'NoneType'>}

Mapping of Onyo types/values for user-oriented output.

Use for onyo_get() output.

onyo.lib.consts.TAG_MAP_TYPES = {'<bool>': <class 'bool'>, '<dict>': (<class 'dict'>, <class 'collections.UserDict'>), '<list>': <class 'list'>}

Mapping of Onyo type-symbols with Python types.

Use for type matching (onyo_get()) queries.

onyo.lib.consts.TAG_MAP_VALUES = {'<false>': False, '<null>': None, '<true>': True}

Mapping of Onyo value symbols with Python values.

Use for type matching (onyo_get()) queries.

onyo.lib.consts.TAG_NULL = '<null>'

Tag symbol for keys with a null value.

Use for type matching (onyo_get()) and output.

onyo.lib.consts.TAG_TRUE = '<true>'

Tag symbol for keys with True as the value.

Use for type matching (onyo_get()).

onyo.lib.consts.TAG_UNSET = '<unset>'

Tag symbol for unset keys.

Use for type matching (onyo_get()) and output.

onyo.lib.consts.TEMPLATE_DIR = PosixPath('.onyo/templates')

Path of the directory that stores templates.