view configmix/constants.py @ 305:f529ca46dd50

Implemented the "ref" namespace to get configuration tree references. BUGS: - Tests should be done more thoroughly and extensively - Interaction of tree references and variable substitution should be tested more properly - Documentation is missing yet
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 26 Apr 2021 09:42:42 +0200
parents 2a2f5b86fe34
children dd454e1efea4
line wrap: on
line source

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

"""

from .compat import 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

"""

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

"""