view configmix/constants.py @ 340:176e22110fc5

docs, tests: notes and additional tests when quoting the "ref" namespace name
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 08 May 2021 19:19:35 +0200
parents f529ca46dd50
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`

"""