Python/libs/ConfigMix: configmix/__init_

annotate configmix/init.py @ 186:fa101fb0cd7a

Implement an "append" keyword to "configmix.set_assoc()"

author	Franz Glasner <fzglas.hg@dom66.de>
date	Fri, 03 May 2019 19:41:35 +0200
parents	7cfdc972af42
children	d2eb83720ad8

rev	line source
0 53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff. Franz Glasner <hg@dom66.de> parents: diff changeset	1 # -- coding: utf-8 --
82 218807d7d883 Remove header markup from the Python files and put them into the doc .rst files Franz Glasner <hg@dom66.de> parents: 79 diff changeset	2 """A library for helping with configuration files.
4 f76d85ccc5b9 Switch to the "New BSD License" Franz Glasner <f.glasner@feldmann-mg.com> parents: 0 diff changeset	3
73 6216c561532a Put a Copyright and License notice into the package's __init__.py Franz Glasner <hg@dom66.de> parents: 69 diff changeset	4 :Author: Franz Glasner
156 e2e8d21b4122 Adjust copyright to year 2019 Franz Glasner <fzglas.hg@dom66.de> parents: 144 diff changeset	5 :Copyright: (c) 2015–2019, Franz Glasner.
73 6216c561532a Put a Copyright and License notice into the package's __init__.py Franz Glasner <hg@dom66.de> parents: 69 diff changeset	6 All rights reserved.
78 3a8f712d27df Put copyright and license into the README.txt Franz Glasner <hg@dom66.de> parents: 73 diff changeset	7 :License: 3-clause BSD License.
73 6216c561532a Put a Copyright and License notice into the package's __init__.py Franz Glasner <hg@dom66.de> parents: 69 diff changeset	8 See LICENSE.txt for details.
174 e2505f524ab9 Use the "@(#)" sigil in the package documentation header Franz Glasner <f.glasner@feldmann-mg.com> parents: 173 diff changeset	9 :ID: @(#) $Header$
4 f76d85ccc5b9 Switch to the "New BSD License" Franz Glasner <f.glasner@feldmann-mg.com> parents: 0 diff changeset	10
f76d85ccc5b9 Switch to the "New BSD License" Franz Glasner <f.glasner@feldmann-mg.com> parents: 0 diff changeset	11 """
0 53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff. Franz Glasner <hg@dom66.de> parents: diff changeset	12
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff. Franz Glasner <hg@dom66.de> parents: diff changeset	13 from __future__ import division, print_function, absolute_import
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff. Franz Glasner <hg@dom66.de> parents: diff changeset	14
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff. Franz Glasner <hg@dom66.de> parents: diff changeset	15
170 c247a5dc35ed Begin development of a version 0.7 with some API changes Franz Glasner <f.glasner@feldmann-mg.com> parents: 167 diff changeset	16 __version__ = "0.7.dev1"
0 53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff. Franz Glasner <hg@dom66.de> parents: diff changeset	17
163 ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	18 __revision__ = "\|VCSRevision\|"
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	19 __date__ = "\|VCSJustDate\|"
52 6c7f90dbce98 Adjusted the Copyright and change the RCS keywords in accordance with "kwarchive" Franz Glasner <hg@dom66.de> parents: 45 diff changeset	20
177 6dde1e344ae8 Style: put "__all__" into the meta-variables section as recommended by PEP Franz Glasner <f.glasner@feldmann-mg.com> parents: 175 diff changeset	21 __all__ = ["load", "safe_load",
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	22 "set_assoc", "get_assoc", "clear_assoc",
7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	23 "get_default_assoc",
180 e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	24 "Configuration",
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	25 "try_determine_filemode"]
177 6dde1e344ae8 Style: put "__all__" into the meta-variables section as recommended by PEP Franz Glasner <f.glasner@feldmann-mg.com> parents: 175 diff changeset	26
0 53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff. Franz Glasner <hg@dom66.de> parents: diff changeset	27
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	28 import fnmatch
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	29 import copy
180 e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	30 import io
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	31 import re
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	32
166 b5ce9a8461bf Use the filesystem encoding explicitely where appropriate. Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	33 from .compat import u, u2fs
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	34 from .config import Configuration
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	35
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	36
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	37 COMMENTS = [u("__comment"),
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	38 u("__doc"),
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	39 ]
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	40 """Prefixes for comment configuration keys that are to be handled as
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	41 comments
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	42
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	43 """
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	44
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	45
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	46 def load(files, *kwargs):
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	47 """Load the given configuration files, merge them in the given order
108 2196362c0467 Enhance documentation of "configmix.load()" Franz Glasner <hg@dom66.de> parents: 107 diff changeset	48 and return the resulting configuration dictionary.
2196362c0467 Enhance documentation of "configmix.load()" Franz Glasner <hg@dom66.de> parents: 107 diff changeset	49
2196362c0467 Enhance documentation of "configmix.load()" Franz Glasner <hg@dom66.de> parents: 107 diff changeset	50 :param files: the filenames of the configuration files to read and merge
173 b3ba2b0265b5 Docu: Explicitely tag "defaults" as keyword argument Franz Glasner <f.glasner@feldmann-mg.com> parents: 172 diff changeset	51 :keyword defaults: optional configuration dictionary with some default
b3ba2b0265b5 Docu: Explicitely tag "defaults" as keyword argument Franz Glasner <f.glasner@feldmann-mg.com> parents: 172 diff changeset	52 settings where the settings from `files` are merged
b3ba2b0265b5 Docu: Explicitely tag "defaults" as keyword argument Franz Glasner <f.glasner@feldmann-mg.com> parents: 172 diff changeset	53 into
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	54 :type defaults: a configuration dictionary or `None`
108 2196362c0467 Enhance documentation of "configmix.load()" Franz Glasner <hg@dom66.de> parents: 107 diff changeset	55 :returns: the configuration
2196362c0467 Enhance documentation of "configmix.load()" Franz Glasner <hg@dom66.de> parents: 107 diff changeset	56 :rtype: ~configmix.config.Configuration
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	57
6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	58 """
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	59 defaults = kwargs.get("defaults")
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	60 if not files:
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	61 if defaults is None:
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	62 return Configuration()
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	63 else:
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	64 return Configuration(defaults)
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	65 else:
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	66 if defaults is None:
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	67 start = 1
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	68 ex = merge(None, _load_cfg_from_file(files[0]))
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	69 else:
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	70 start = 0
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	71 ex = merge(None, defaults)
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	72 for f in files[start:]:
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	73 ex = merge(_load_cfg_from_file(f), ex)
6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	74 return Configuration(ex)
6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	75
6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	76
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	77 def safe_load(files, *kwargs):
112 c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	78 """Analogous to :func:`load` but do merging with :func:`safe_merge`
c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	79 instead of :func:`merge`
c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	80
c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	81 """
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	82 defaults = kwargs.get("defaults")
112 c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	83 if not files:
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	84 if defaults is None:
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	85 return Configuration()
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	86 else:
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	87 return Configuration(defaults)
112 c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	88 else:
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	89 if defaults is None:
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	90 start = 1
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	91 ex = merge(None, _load_cfg_from_file(files[0]))
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	92 else:
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	93 start = 0
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	94 ex = merge(None, defaults)
112 c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	95 ex = safe_merge(None, _load_cfg_from_file(files[0]))
172 8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings Franz Glasner <f.glasner@feldmann-mg.com> parents: 171 diff changeset	96 for f in files[start:]:
112 c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	97 ex = safe_merge(_load_cfg_from_file(f), ex)
c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	98 return Configuration(ex)
c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	99
c50ad93eb5dc Implemented a "safe_load()" to load with safe merging Franz Glasner <hg@dom66.de> parents: 111 diff changeset	100
138 b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	101 def _load_yaml(filename):
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	102 from . import yaml
166 b5ce9a8461bf Use the filesystem encoding explicitely where appropriate. Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	103 with open(u2fs(filename), "rb") as yf:
138 b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	104 return yaml.safe_load(yf)
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	105
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	106
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	107 def _load_json(filename):
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	108 from . import json
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	109 return json.load(filename)
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	110
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	111
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	112 def _load_py(filename):
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	113 from . import py
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	114 return py.load(filename)
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	115
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	116
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	117 def _load_ini(filename):
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	118 from . import ini
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	119 return ini.load(filename)
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	120
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	121
180 e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	122 EMACS_MODELINE = re.compile(r"-\-(.?)-\*-")
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	123 EMACS_MODE = re.compile(r"(?:\A\s\|;\s)mode[:=]\s*([-_.a-zA-Z0-9]+)")
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	124
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	125
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	126 def try_determine_filemode(filename):
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	127 """Try to determine an explicitely given filemode from an Emacs-compatible
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	128 mode declaration (e.g. ``mode=python``).
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	129
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	130 :param str filename:
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	131 :return: the found mode string or `None`
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	132 :rtype: str or None
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	133
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	134 Only the first two lines are searched for.
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	135
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	136 """
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	137 with io.open(filename, encoding="ascii", errors="replace") as f:
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	138 idx = 0
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	139 for l in f:
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	140 idx += 1
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	141 mo = EMACS_MODELINE.search(l)
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	142 if mo:
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	143 mo = EMACS_MODE.search(mo.group(1))
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	144 if mo:
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	145 return mo.group(1)
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	146 if idx >= 2:
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	147 break
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	148 return None
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	149
e87fa5bd68e7 Implemented "try_determine_filemode()" to determine a file-mode from an Emacs-compatible declaration Franz Glasner <fzglas.hg@dom66.de> parents: 179 diff changeset	150
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	151 DEFAULT_MODE_LOADERS = {
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	152 "python": _load_py,
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	153 "yaml": _load_yaml,
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	154 "conf": _load_ini,
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	155 "conf-windows": _load_ini,
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	156 "ini": _load_ini,
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	157 "javascript": _load_json,
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	158 "json": _load_json,
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	159 }
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	160 """Default associations between file modes and loader functions"""
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	161
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	162
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	163 DEFAULT_ASSOC = [
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	164 ("*.yml", "yaml"),
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	165 ("*.yaml", "yaml"),
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	166 ("*.json", "json"),
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	167 ("*.py", "python"),
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	168 ("*.ini", "conf"),
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	169 ]
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	170 """The builtin default associations of filename extensions with
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	171 file modes -- in that order.
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	172
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	173 The "mode" part may be a string or a callable with a filename
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	174 parameter that returns the mode string for the file or `None` if it
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	175 can not determined.
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	176
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	177 """
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	178
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	179
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	180 DEFAULT_LOADER = object()
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	181 """Marker for the default association for an extension.
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	182
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	183 To be used in :func:`set_assoc`.
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	184 """
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	185
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	186
7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	187 def get_default_assoc(pattern):
7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	188 """Return the default file-mode association for the :mod:`fnmatch`
7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	189 pattern `pattern`.
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	190
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	191 :raises: :class:`KeyError` if the `pattern` is not found.
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	192
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	193 """
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	194 for pat, fmode in DEFAULT_ASSOC:
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	195 if pattern == pat:
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	196 return fmode
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	197 else:
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	198 raise KeyError("No loader for pattern %r" % pattern)
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	199
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	200
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	201 _mode_loaders = {}
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	202 """All configured associations between file modes and loader functions.
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	203
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	204 See :data:`DEFAULT_MODE_LOADERS.
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	205
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	206 """
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	207
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	208 _extensions = []
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	209 """All configured assiciations of filename extensions with file modes.
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	210
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	211 See :data:`DEFAULT_ASSOC`
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	212
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	213 """
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	214
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	215
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	216 def clear_assoc():
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	217 """Remove all configured loader associations.
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	218
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	219 The :data:`_default_loaders` are not changed.
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	220
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	221 """
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	222 del _extensions[:]
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	223
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	224
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	225 def get_assoc(pattern):
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	226 """Return the default loader for the :mod:`fnmatch` pattern `pattern`.
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	227
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	228 :raises: :class:`KeyError` if the `pattern` is not found.
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	229
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	230 """
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	231 for pat, fmode in _extensions:
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	232 if pattern == pat:
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	233 return fmode
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	234 else:
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	235 raise KeyError("No associated file-mode for pattern %r" % pattern)
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	236
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	237
186 fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	238 def set_assoc(fnpattern, mode, append=False):
179 62db35db8939 Docu: formatting Franz Glasner <f.glasner@feldmann-mg.com> parents: 178 diff changeset	239 """Associate a :mod:`fnmatch` style pattern `fnpattern` with a
62db35db8939 Docu: formatting Franz Glasner <f.glasner@feldmann-mg.com> parents: 178 diff changeset	240 file-mode `mode` that determines what will be called when
62db35db8939 Docu: formatting Franz Glasner <f.glasner@feldmann-mg.com> parents: 178 diff changeset	241 :func:`load` encounters a file argument that matches `fnpattern`.
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	242
179 62db35db8939 Docu: formatting Franz Glasner <f.glasner@feldmann-mg.com> parents: 178 diff changeset	243 :param str fnpattern: the :mod:`fnmatch` pattern to associate a loader
62db35db8939 Docu: formatting Franz Glasner <f.glasner@feldmann-mg.com> parents: 178 diff changeset	244 with
186 fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	245 :param mode: a mode string or a callable that accepts a `filename`
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	246 argument and returns a file-mode for the given file
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	247 (or `None`)
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	248 :type mode: str or callable
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	249
186 fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	250 :keyword bool append: If `False` (which is the default) then this
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	251 function inserts the given pattern at the head position of the
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	252 currently defined associations, if `True` the pattern will be appended
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	253
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	254 The OS specific case-sensitivity behaviour of
175 327032bb0f6b Docu: wording Franz Glasner <f.glasner@feldmann-mg.com> parents: 174 diff changeset	255 :func:`fnmatch.fnmatch` applies (i.e. :func:`os.path.normpath`
327032bb0f6b Docu: wording Franz Glasner <f.glasner@feldmann-mg.com> parents: 174 diff changeset	256 will be called for both arguments).
141 647782859ae1 An extra hint that filename extension comparisons for loader lookup are case-insensitive Franz Glasner <hg@dom66.de> parents: 139 diff changeset	257
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	258 If `loader` is :data:`DEFAULT_ASSOC` then the default association
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	259 from :data:`_default_loaders` will be used -- if any.
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	260
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	261 """
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	262 if mode is DEFAULT_LOADER:
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	263 for p, m in DEFAULT_ASSOC:
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	264 if p == fnpattern:
186 fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	265 if append:
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	266 _extensions.append((fnpattern, m))
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	267 else:
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	268 _extensions.insert(0, (fnpattern, m))
171 1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	269 break
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now. Franz Glasner <f.glasner@feldmann-mg.com> parents: 170 diff changeset	270 else:
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	271 raise ValueError("no DEFAULT mode for pattern: %r" % fnpattern)
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	272 else:
186 fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	273 if append:
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	274 _extensions.append((fnpattern, mode))
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	275 else:
fa101fb0cd7a Implement an "append" keyword to "configmix.set_assoc()" Franz Glasner <fzglas.hg@dom66.de> parents: 181 diff changeset	276 _extensions.insert(0, (fnpattern, mode))
138 b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	277
b883f4ef1967 Indirectly map extensions to configuration file styles Franz Glasner <hg@dom66.de> parents: 122 diff changeset	278
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	279 def _load_cfg_from_file(filename):
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	280 for p, m in _extensions:
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	281 if fnmatch.fnmatch(filename, p):
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	282 if callable(m):
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	283 m = m(filename)
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	284 if m is None:
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	285 continue
eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	286 return _mode_loaders[m](filename)
22 6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	287 else:
6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	288 raise ValueError("Unknown configuration file type for filename "
6a91db2c2469 A convenience function to load and merge a list of configuration files with different styles Franz Glasner <f.glasner@feldmann-mg.com> parents: 13 diff changeset	289 "%r" % filename)
8 7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	290
7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	291
11 aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	292 if 0:
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	293 #
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	294 # From: https://github.com/jet9/python-yconfig/blob/master/yconfig.py
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	295 # License: BSD License
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	296 #
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	297 def dict_merge(a, b):
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	298 """Recursively merges dict's. not just simple a['key'] = b['key'], if
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	299 both a and bhave a key who's value is a dict then dict_merge is called
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	300 on both values and the result stored in the returned dictionary."""
8 7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	301
11 aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	302 if not isinstance(b, dict):
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	303 return b
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	304 result = deepcopy(a)
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	305 for k, v in b.iteritems():
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	306 if k in result and isinstance(result[k], dict):
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	307 result[k] = dict_merge(result[k], v)
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	308 else:
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	309 result[k] = deepcopy(v)
aecb36d4025f Deactivate the "dict_merge()" function from yconfig Franz Glasner <f.glasner@feldmann-mg.com> parents: 10 diff changeset	310 return result
8 7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	311
7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	312
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	313 def merge(user, default, filter_comments=True):
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	314 """Logically merge the configuration in `user` into `default`.
98 d6ba53ce2091 Better documentation of the core function in "configmix" Franz Glasner <f.glasner@feldmann-mg.com> parents: 96 diff changeset	315
d6ba53ce2091 Better documentation of the core function in "configmix" Franz Glasner <f.glasner@feldmann-mg.com> parents: 96 diff changeset	316 :param ~configmix.config.Configuration user:
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	317 the new configuration that will be logically merged
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	318 into `default`
98 d6ba53ce2091 Better documentation of the core function in "configmix" Franz Glasner <f.glasner@feldmann-mg.com> parents: 96 diff changeset	319 :param ~configmix.config.Configuration default:
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	320 the base configuration where `user` is logically merged into
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	321 :param bool filter_comments: flag whether to filter comment keys that
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	322 start with any of the items in :data:`COMMENTS`
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	323 :returns: `user` with the necessary amendments from `default`.
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	324 If `user` is ``None`` then `default` is returned.
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	325
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	326 .. note:: The configuration in `user` is augmented/changed
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	327 inplace.
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	328
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	329 The configuration in `default` will be changed inplace
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	330 when filtering out comments (which is the default).
8 7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	331
7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	332 From http://stackoverflow.com/questions/823196/yaml-merge-in-python
7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	333
7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	334 """
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	335 if user is None:
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	336 if filter_comments:
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	337 _filter_comments(default)
13 24ba462b9b4b Return the `default' argument when the given `user' argument is `None' and when it is the first call on merge Franz Glasner <f.glasner@feldmann-mg.com> parents: 11 diff changeset	338 return default
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	339 if filter_comments:
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	340 _filter_comments(user)
8 7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	341 if isinstance(user, dict) and isinstance(default, dict):
9 6835a5663008 FIX: Style Franz Glasner <f.glasner@feldmann-mg.com> parents: 8 diff changeset	342 for k, v in default.items():
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	343 if filter_comments and _is_comment(k):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	344 continue
8 7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	345 if k not in user:
7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	346 user[k] = v
7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	347 else:
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	348 user[k] = _merge(user[k], v, filter_comments)
8 7090c295c940 Two differend tree merge function implementations: not yet finished Franz Glasner <hg@dom66.de> parents: 5 diff changeset	349 return user
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	350
58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	351
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	352 def _merge(user, default, filter_comments):
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	353 """Recursion helper for :meth:`merge`
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	354
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	355 """
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	356 if isinstance(user, dict) and isinstance(default, dict):
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	357 for k, v in default.items():
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	358 if filter_comments and _is_comment(k):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	359 continue
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	360 if k not in user:
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	361 user[k] = v
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	362 else:
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	363 user[k] = _merge(user[k], v, filter_comments)
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	364 return user
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	365
29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	366
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	367 def safe_merge(user, default, filter_comments=True):
111 d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	368 """A more safe version of :func:`merge` that makes deep copies of
13 24ba462b9b4b Return the `default' argument when the given `user' argument is `None' and when it is the first call on merge Franz Glasner <f.glasner@feldmann-mg.com> parents: 11 diff changeset	369 the returned container objects.
24ba462b9b4b Return the `default' argument when the given `user' argument is `None' and when it is the first call on merge Franz Glasner <f.glasner@feldmann-mg.com> parents: 11 diff changeset	370
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	371 Contrary to :func:`merge` no given argument is ever changed
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	372 inplace. Every object from `default` is decoupled from the result
165 6ca90e80f4f4 FIX: Docu: wording Franz Glasner <fzglas.hg@dom66.de> parents: 163 diff changeset	373 -- so changing the `default` configuration later does not propagate
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	374 into a merged configuration later.
111 d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	375
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	376 """
110 29cf359ddf4d Remove the "_first" parameter from "merge" and "safe_merge" by splitting into two functions Franz Glasner <hg@dom66.de> parents: 108 diff changeset	377 if user is None:
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	378 if filter_comments:
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	379 _filter_comments(default)
111 d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	380 return copy.deepcopy(default)
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	381 user = copy.deepcopy(user)
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	382 if filter_comments:
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	383 _filter_comments(user)
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	384 if isinstance(user, dict) and isinstance(default, dict):
58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	385 for k, v in default.items():
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	386 if filter_comments and _is_comment(k):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	387 continue
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	388 if k not in user:
111 d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	389 user[k] = copy.deepcopy(v)
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	390 else:
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	391 user[k] = _safe_merge(user[k], v, filter_comments)
10 58af59d5af40 A "safe_merge" that makes (shallow) copies instead of directly manipulating given containers Franz Glasner <f.glasner@feldmann-mg.com> parents: 9 diff changeset	392 return user
111 d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	393
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	394
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	395 def _safe_merge(user, default, filter_comments):
111 d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	396 """Recursion helper for :meth:`safe_merge`
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	397
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	398 """
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	399 if isinstance(user, dict) and isinstance(default, dict):
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	400 for k, v in default.items():
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	401 if filter_comments and _is_comment(k):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	402 continue
111 d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	403 if k not in user:
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	404 user[k] = copy.deepcopy(v)
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	405 else:
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	406 user[k] = _safe_merge(user[k], v, filter_comments)
111 d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging. Franz Glasner <hg@dom66.de> parents: 110 diff changeset	407 return user
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	408
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	409
144 7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	410 def _filter_comments(d):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	411 """Recursively filter comments keys in the dict `d`.
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	412
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	413 Comment keys are keys that start with any of the items in
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	414 :data:`COMMENTS`.
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	415
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	416 """
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	417 if not isinstance(d, dict):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	418 return
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	419 # use a copy of the keys because we change `d` while iterating
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	420 for k in list(d.keys()):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	421 if _is_comment(k):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	422 del d[k]
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	423 else:
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	424 if isinstance(d[k], dict):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	425 _filter_comments(d[k])
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	426
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	427
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	428 def _is_comment(k):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	429 for i in COMMENTS:
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	430 if k.startswith(i):
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	431 return True
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	432 return False
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	433
7e6ec99d5ff5 Allow comments as keys and filter them by default Franz Glasner <hg@dom66.de> parents: 141 diff changeset	434
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	435 #
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	436 # Init loader defaults: mode->loader and extension->mode
139 c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles Franz Glasner <hg@dom66.de> parents: 138 diff changeset	437 #
178 eeb3ed104ea1 Begin refactoring the associations between filename extensions and loader functions: Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	438 _mode_loaders.update(DEFAULT_MODE_LOADERS)
181 7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	439 for _pattern, _mode in DEFAULT_ASSOC:
7cfdc972af42 Refactor: Renamed public functions to be conform with the new loader search Franz Glasner <fzglas.hg@dom66.de> parents: 180 diff changeset	440 set_assoc(_pattern, _mode)

Mercurial > hgrepos > Python > libs > ConfigMix

annotate configmix/__init__.py @ 186:fa101fb0cd7a

annotate configmix/init.py @ 186:fa101fb0cd7a