view configmix/constants.py @ 714:465bac57b97e

Docs: Docs for configmix.config: use more manual docs. This is also to document more closely the pure-Python implementation, the C-API implementation and their aliases.
author Franz Glasner <f.glasner@feldmann-mg.com>
date Tue, 15 Aug 2023 17:14:21 +0200
parents 4499e9b4855d
children
line wrap: on
line source

# -*- coding: utf-8 -*-
# :-
# :Copyright: (c) 2015-2022, Franz Glasner. All rights reserved.
# :License:   BSD-3-Clause. See LICENSE.txt for details.
# :-
"""Some important public contants

"""

from .compat import u as _u


COMMENTS = [
    _u("__comment"),
    _u("__doc"),
]
"""Prefixes for comment configuration keys that are to be handled as
comments

"""

DIR_PREFIX = _u("<dir>")
"""Prefix for configuration values to read other configuration files from
given directory

"""

DEL_VALUE = _u("{{::DEL::}}")
"""Value for configuration items to signal that the corresponding
key-value is to be deleted when configurations are merged.

Despite having "interpolation" syntax this value will **never** be
substituted.

"""

REF_NAMESPACE = _u("ref")
"""Special internal namespace used for implementation of tree
`references`

"""

NONE_FILTER = _u("None")
"""The public name of the special `None` filter"""

EMPTY_FILTER = _u("Empty")
"""The public name of the special `None` filter"""