/usr/lib/python3/dist-packages/invoke/config.py is in python3-invoke 0.11.1+dfsg1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 | import copy
import json
import os
import sys
from os.path import join, splitext, expanduser
import six
import yaml
if sys.version_info[:2] >= (3, 3):
from importlib.machinery import SourceFileLoader
def load_source(name, path):
if not os.path.exists(path):
return {}
return vars(SourceFileLoader('mod', path).load_module())
else:
import imp
def load_source(name, path):
if not os.path.exists(path):
return {}
return vars(imp.load_source('mod', path))
from .env import Environment
from .exceptions import UnknownFileType
from .util import debug
from .platform import WINDOWS
class DataProxy(object):
"""
Helper class implementing nested dict+attr access for `.Config`.
"""
# Attributes which get proxied through to inner etc.Config obj.
_proxies = tuple("""
clear
get
has_key
items
iteritems
iterkeys
itervalues
keys
pop
popitem
setdefault
update
values
""".split()) + tuple("__{0}__".format(x) for x in """
cmp
contains
iter
sizeof
""".split())
# Alt constructor used so we aren't getting in the way of Config's real
# __init__().
@classmethod
def from_data(cls, data):
obj = cls()
obj.config = data
return obj
def __getattr__(self, key):
try:
return self._get(key)
except KeyError:
# Proxy most special vars to config for dict procotol.
if key in self._proxies:
return getattr(self.config, key)
# Otherwise, raise useful AttributeError to follow getattr proto.
err = "No attribute or config key found for {0!r}".format(key)
attrs = [x for x in dir(self.__class__) if not x.startswith('_')]
err += "\n\nValid keys: {0!r}".format(
sorted(list(self.config.keys()))
)
err += "\n\nValid real attributes: {0!r}".format(attrs)
raise AttributeError(err)
def __hasattr__(self, key):
return key in self.config or key in self._proxies
def __iter__(self):
# For some reason Python is ignoring our __hasattr__ when determining
# whether we support __iter__. BOO
return iter(self.config)
def __eq__(self, other):
# Can't proxy __eq__ because the RHS will always be an obj of the
# current class, not the proxied-to class, and that causes
# NotImplemented.
return self.config == other.config
def __len__(self):
# Can't proxy __len__ either apparently? ugh
return len(self.config)
def __setitem__(self, key, value):
# ... or __setitem__? thanks for nothing Python >:(
self.config[key] = value
def __delitem__(self, key):
# OK this is really getting annoying
del self.config[key]
def __getitem__(self, key):
return self._get(key)
def _get(self, key):
value = self.config[key]
if isinstance(value, dict):
value = DataProxy.from_data(value)
return value
def __str__(self):
return "<{0}: {1}>".format(self.__class__.__name__, self.config)
def __unicode__(self):
return unicode(self.__str__()) # noqa
def __repr__(self):
# TODO: something more useful? Not an easy object to reconstruct from a
# stringrep.
return self.__str__()
def __contains__(self, key):
return key in self.config
# TODO: copy()?
class Config(DataProxy):
"""
Invoke's primary configuration handling class.
See :doc:`/concepts/configuration` for details on the configuration system
this class implements, including the :ref:`configuration hierarchy
<config-hierarchy>`. The rest of this class' documentation assumes
familiarity with that document.
**Access**
Configuration values may be accessed using dict syntax::
config['foo']
or attribute syntax::
config.foo
Nesting works the same way - dict config values are turned into objects
which honor both the dictionary protocol and the attribute-access method::
config['foo']['bar']
config.foo.bar
**A note about attribute access and methods**
This class implements the entire dictionary protocol: methods such as
``keys``, ``values``, ``items``, ``pop`` and so forth should all function
as they do on regular dicts. It also implements its own methods such as
`.load_collection` and `.clone`.
.. warning::
Accordingly, this means that if you have configuration options sharing
names with these methods, you **must** use dictionary syntax (e.g.
``myconfig['keys']``) to access them.
Individual configuration 'levels' and their source locations are stored as
'private' attributes (e.g. ``_defaults``, ``_system_prefix``) so fewer
names are "taken" from the perspective of attribute access to user config
values.
**Lifecycle**
On initialization, `.Config` will seek out and load various configuration
files from disk, then `.merge` the results with other in-memory sources
such as defaults and CLI overrides.
Typically, the `.load_collection` and `.load_shell_env` methods are called
after initialization - `.load_collection` prior to each task invocation
(because collection-level config data may change depending on the task) and
`.load_shell_env` as the final step (as it needs the rest of the config to
know which env vars are valid to load).
Once users are given a copy of the configuration (usually via their task's
`.Context` argument) all the above loading (& a final `.merge`) has been
performed and they are free to modify it as they would any other regular
dictionary.
.. warning::
Calling `.merge` after manually modifying `.Config` objects may
overwrite those manual changes, since it overwrites the core config
dict with data from per-source attributes like ``._defaults`` or
``_.user``.
"""
@staticmethod
def global_defaults():
"""
Return the core default settings for Invoke.
Generally only for use by `.Config` internals. For descriptions of
these values, see :ref:`default-values`.
Subclasses may choose to override this method, calling
``Config.global_defaults`` and applying `.merge_dicts` to the result,
to add to or modify these values.
"""
return {
'run': {
'warn': False,
'hide': None,
'pty': False,
'fallback': True,
'echo': False,
'encoding': None,
'out_stream': None,
'err_stream': None,
},
'tasks': {'dedupe': True},
}
def __init__(
self,
defaults=None,
overrides=None,
system_prefix=None,
user_prefix=None,
project_home=None,
env_prefix=None,
runtime_path=None
):
"""
Creates a new config object.
:param dict defaults:
A dict containing default (lowest level) config data. Default:
`global_defaults`.
:param dict overrides:
A dict containing override-level config data. Default: ``{}``.
:param str system_prefix:
Path & partial filename for the global config file location. Should
include everything but the dot & file extension.
Default: ``/etc/invoke`` (e.g. ``/etc/invoke.yaml`` or
``/etc/invoke.json``).
:param str user_prefix:
Like ``system_prefix`` but for the per-user config file.
Default: ``~/.invoke`` (e.g. ``~/.invoke.yaml``).
:param str project_home:
Optional directory path location of the currently loaded
`.Collection` (as loaded by `.Loader`). When non-empty, will
trigger seeking of per-project config files in this location +
``invoke.(yaml|json|py)``.
:param str env_prefix:
Environment variable seek prefix; optional, defaults to ``None``.
When not ``None``, only environment variables beginning with this
value will be loaded. If it is set, the keys will have the prefix
stripped out before processing, so e.g. ``env_prefix='INVOKE_'``
means users must set ``INVOKE_MYSETTING`` in the shell to affect
the ``"mysetting"`` setting.
:param str runtime_path:
Optional file path to a runtime configuration file.
Used to fill the penultimate slot in the config hierarchy. Should
be a full file path to an existing file, not a directory path, or a
prefix.
"""
# Config file suffixes to search, in preference order.
self._file_suffixes = ('yaml', 'json', 'py')
# Technically an implementation detail - do not expose in public API.
# Stores merged configs and is accessed via DataProxy.
self.config = {}
#: Default configuration values, typically a copy of
#: `global_defaults`.
if defaults is None:
defaults = copy.deepcopy(self.global_defaults())
self._defaults = defaults
#: Collection-driven config data, gathered from the collection tree
#: containing the currently executing task.
self._collection = {}
#: Path prefix searched for the system config file.
#: There is no default system prefix on Windows
if system_prefix is None:
self._system_prefix = (None if WINDOWS else '/etc/invoke')
else:
self._system_prefix = system_prefix
#: Path to loaded system config file, if any.
self._system_path = None
#: Whether the system config file has been loaded or not (or ``None``
#: if no loading has been attempted yet.)
self._system_found = None
#: Data loaded from the system config file.
self._system = {}
#: Path prefix searched for per-user config files.
self._user_prefix = '~/.invoke' if user_prefix is None else user_prefix
#: Path to loaded user config file, if any.
self._user_path = None
#: Whether the user config file has been loaded or not (or ``None``
#: if no loading has been attempted yet.)
self._user_found = None
#: Data loaded from the per-user config file.
self._user = {}
#: Parent directory of the current root tasks file, if applicable.
self._project_home = project_home
# And a normalized prefix version not really publicly exposed
self._project_prefix = None
if self._project_home is not None:
self._project_prefix = join(project_home, 'invoke')
#: Path to loaded per-project config file, if any.
self._project_path = None
#: Whether the project config file has been loaded or not (or ``None``
#: if no loading has been attempted yet.)
self._project_found = None
#: Data loaded from the per-project config file.
self._project = {}
#: Environment variable name prefix
# TODO: make this INVOKE_ and update tests to account?
self._env_prefix = '' if env_prefix is None else env_prefix
#: Config data loaded from the shell environment.
self._env = {}
#: Path to the user-specified runtime config file.
self._runtime_path = runtime_path
#: Data loaded from the runtime config file.
self._runtime = {}
#: Whether the runtime config file has been loaded or not (or ``None``
#: if no loading has been attempted yet.)
self._runtime_found = None
#: Overrides - highest possible config level. Typically filled in from
#: command-line flags.
self._overrides = {} if overrides is None else overrides
# Perform initial load & merge.
self.load_files()
self.merge()
def load_shell_env(self):
"""
Load values from the shell environment.
`.load_shell_env` is intended for execution late in a `.Config`
object's lifecycle, once all other sources have been merged. Loading
from the shell is not terrifically expensive, but must be done at a
specific point in time to ensure the "only known config keys are loaded
from the env" behavior works correctly.
See :ref:`env-vars` for details on this design decision and other info
re: how environment variables are scanned and loaded.
"""
# Force merge of existing data to ensure we have an up to date picture
debug("Running pre-merge for shell env loading...")
self.merge()
debug("Done with pre-merge.")
loader = Environment(config=self.config, prefix=self._env_prefix)
self._env = loader.load()
debug("Loaded shell environment, triggering final merge")
self.merge()
def load_collection(self, data):
"""
Update collection-driven config data.
`.load_collection` is intended for use by the core task execution
machinery, which is responsible for obtaining per-task
collection-driven data. See :ref:`collection-configuration` for
details.
.. note:: This method triggers `.merge` after it runs.
"""
self._collection = data
self.merge()
def clone(self):
"""
Return a copy of this configuration object.
The new object will be identical in terms of configured sources and any
loaded/merged data, but will be a distinct object with no shared
mutable state.
"""
new = Config()
for name in """
defaults
collection
system_prefix
system_path
system_found
system
user_prefix
user_path
user_found
user
project_home
project_prefix
project_path
project_found
project
env_prefix
env
runtime_path
runtime_found
runtime
overrides
""".split():
name = "_{0}".format(name)
setattr(new, name, copy.deepcopy(getattr(self, name)))
new.config = copy.deepcopy(self.config)
return new
def load_files(self):
"""
Load any unloaded/un-searched-for config file sources.
Specifically, any file sources whose ``_found`` values are ``None``
will be sought and loaded if found; if their ``_found`` value is non
``None`` (e.g. ``True`` or ``False``) they will be skipped. Typically
this means this method is idempotent and becomes a no-op after the
first run.
Execution of this method does not imply merging; use `.merge` for that.
"""
self._load_file(prefix='system')
self._load_file(prefix='user')
self._load_file(prefix='project')
self._load_file(prefix='runtime', absolute=True)
def _load_file(self, prefix, absolute=False):
# Setup
found = "_{0}_found".format(prefix)
path = "_{0}_path".format(prefix)
data = "_{0}".format(prefix)
# Short-circuit if loading appears to have occurred already
if getattr(self, found) is not None:
return
# Moar setup
if absolute:
absolute_path = getattr(self, path)
# None -> expected absolute path but none set, short circuit
if absolute_path is None:
return
paths = [absolute_path]
else:
path_prefix = getattr(self, "_{0}_prefix".format(prefix))
# Short circuit if loading seems unnecessary (eg for project config
# files when not running out of a project)
if path_prefix is None:
return
paths = [
'.'.join((path_prefix, x))
for x in self._file_suffixes
]
# Poke 'em
for filepath in paths:
# Normalize
filepath = expanduser(filepath)
try:
try:
type_ = splitext(filepath)[1].lstrip('.')
loader = getattr(self, "_load_{0}".format(type_))
except AttributeError as e:
msg = "Config files of type {0!r} (from file {1!r}) are not supported! Please use one of: {2!r}" # noqa
raise UnknownFileType(msg.format(
type_, filepath, self._file_suffixes))
# Store data, the path it was found at, and fact that it was
# found
setattr(self, data, loader(filepath))
setattr(self, path, filepath)
setattr(self, found, True)
break
# Typically means 'no such file', so just note & skip past.
except IOError as e:
# TODO: is there a better / x-platform way to detect this?
if "No such file" in e.strerror:
err = "Didn't see any {0}, skipping."
debug(err.format(filepath))
else:
raise
# Still None -> no suffixed paths were found, record this fact
if getattr(self, path) is None:
setattr(self, found, False)
def merge(self):
"""
Merge all config sources, in order.
Does not imply loading of config files or environment variables; use
`.load_files` and/or `.load_shell_env` beforehand instead.
"""
debug("Merging config sources in order...")
debug("Defaults: {0!r}".format(self._defaults))
merge_dicts(self.config, self._defaults)
debug("Collection-driven: {0!r}".format(self._collection))
merge_dicts(self.config, self._collection)
self._merge_file('system', "System-wide")
self._merge_file('user', "Per-user")
self._merge_file('project', "Per-project")
debug("Environment variable config: {0!r}".format(self._env))
merge_dicts(self.config, self._env)
self._merge_file('runtime', "Runtime")
debug("Overrides: {0!r}".format(self._overrides))
merge_dicts(self.config, self._overrides)
def _merge_file(self, name, desc):
# Setup
desc += " config file" # yup
found = getattr(self, "_{0}_found".format(name))
path = getattr(self, "_{0}_path".format(name))
data = getattr(self, "_{0}".format(name))
# None -> no loading occurred yet
if found is None:
debug("{0} has not been loaded yet, skipping".format(desc))
# True -> hooray
elif found:
debug("{0} ({1}): {2!r}".format(desc, path, data))
merge_dicts(self.config, data)
# False -> did try, did not succeed
else:
# TODO: how to preserve what was tried for each case but only for
# the negative? Just a branch here based on 'name'?
debug("{0} not found, skipping".format(desc))
@property
def paths(self):
"""
An iterable of all successfully loaded config file paths.
No specific order.
"""
paths = []
for prefix in "system user project runtime".split():
value = getattr(self, "_{0}_path".format(prefix))
if value is not None:
paths.append(value)
return paths
def _load_yaml(self, path):
with open(path) as fd:
return yaml.load(fd)
def _load_json(self, path):
with open(path) as fd:
return json.load(fd)
def _load_py(self, path):
data = {}
for key, value in six.iteritems(load_source('mod', path)):
if key.startswith('__'):
continue
data[key] = value
return data
class AmbiguousMergeError(ValueError):
pass
def merge_dicts(base, updates):
"""
Recursively merge dict ``updates`` into dict ``base`` (mutating ``base``.)
* Values which are themselves dicts will be recursed into.
* Values which are a dict in one input and *not* a dict in the other input
(e.g. if our inputs were ``{'foo': 5}`` and ``{'foo': {'bar': 5}}``) are
irreconciliable and will generate an exception.
"""
for key, value in updates.items():
# Dict values whose keys also exist in 'base' -> recurse
# (But only if both types are dicts.)
if key in base:
if isinstance(value, dict):
if isinstance(base[key], dict):
merge_dicts(base[key], value)
else:
raise _merge_error(base[key], value)
else:
if isinstance(base[key], dict):
raise _merge_error(base[key], value)
else:
base[key] = value
# New values just get set straight
else:
base[key] = value
def _merge_error(orig, new_):
return AmbiguousMergeError("Can't cleanly merge {0} with {1}".format(
_format_mismatch(orig), _format_mismatch(new_)
))
def _format_mismatch(x):
return "{0} ({1!r})".format(type(x), x)
|