def from_json(E,json_string=_A,filename=_A,encoding=_B,errors=_C,multiline=_D,**A):
D={}
for B in list(A.keys()):
if B in BOX_PARAMETERS:D[B]=A.pop(B)
C=_from_json(json_string,filename=filename,encoding=encoding,errors=errors,multiline=multiline,**A)
if not isinstance(C,list):raise BoxError(f"json data not returned as a list, but rather a {type(C).__name__}")
return E(C,**D)
def from_yaml(E,yaml_string=_A,filename=_A,encoding=_B,errors=_C,**A):
D={}
for B in list(A.keys()):
if B in BOX_PARAMETERS:D[B]=A.pop(B)
C=_from_yaml(yaml_string=yaml_string,filename=filename,encoding=encoding,errors=errors,**A)
if not isinstance(C,list):raise BoxError(f"yaml data not returned as a list but rather a {type(C).__name__}")
return E(C,**D)
def __init__(A,iterable=_A,box_class=_A,**C): B=iterable;A.box_class=box_class or get_dynabox_class_avoiding_circular_import();A.box_options=C;A.box_org_ref=A.box_org_ref=id(B)if B else 0 if B: for D in B:A.append(D) if C.get(_E): def E(*A,**B):raise BoxError(_F) for F in ['append','extend','insert','pop','remove','reverse','sort']:A.__setattr__(F,E)
def __init__(self, settings_module=None, **kwargs): # pragma: no cover
"""Execute loaders and custom initialization
:param settings_module: defines the setttings file
:param kwargs: override default settings
"""
self._fresh = False
self._loaded_envs = []
self._loaded_files = []
self._deleted = set()
self._store = DynaBox(box_settings=self)
self._env_cache = {}
self._loaded_by_loaders = {}
self._loaders = []
self._defaults = DynaBox(box_settings=self)
self.environ = os.environ
self.SETTINGS_MODULE = None
self._not_installed_warnings = []
self.validators = ValidatorList(
self, validators=kwargs.pop("validators", None)
)
compat_kwargs(kwargs)
if settings_module:
self.set("SETTINGS_FILE_FOR_DYNACONF", settings_module)
for key, value in kwargs.items():
self.set(key, value)
# execute loaders only after setting defaults got from kwargs
self._defaults = kwargs
self.execute_loaders()
self.validators.validate()
def _dotted_set(self, dotted_key, value, tomlfy=False, **kwargs):
"""Sets dotted keys as nested dictionaries.
Dotted set will always reassign the value, to merge use `@merge` token
Arguments:
dotted_key {str} -- A traversal name e.g: foo.bar.zaz
value {Any} -- The value to set to the nested value.
Keyword Arguments:
tomlfy {bool} -- Perform toml parsing (default: {False})
"""
split_keys = dotted_key.split(".")
existing_data = self.get(split_keys[0], {})
new_data = tree = DynaBox(box_settings=self)
for k in split_keys[:-1]:
tree = tree.setdefault(k, {})
value = parse_conf_data(value, tomlfy=tomlfy, box_settings=self)
tree[split_keys[-1]] = value
if existing_data:
new_data = object_merge(
old=DynaBox({split_keys[0]: existing_data}),
new=new_data,
full_path=split_keys,
)
self.update(data=new_data, tomlfy=tomlfy, **kwargs)
def append(A,p_object): B=p_object if isinstance(B,dict)and not A._is_intact_type(B): try:B=A.box_class(B,**A.box_options) except AttributeError as C: if'box_class'in A.__dict__:raise BoxKeyError(C) elif isinstance(B,list)and not A._is_intact_type(B): try:B=A if id(B)==A.box_org_ref else BoxList(B,**A.box_options) except AttributeError as C: if'box_org_ref'in A.__dict__:raise BoxKeyError(C) super(BoxList,A).append(B)
def test_accessing_dynabox_inside_boxlist_inside_dynabox():
data = DynaBox({"nested": [{"deeper": "nest"}]})
assert data.nested[0].deeper == "nest"
assert data.NESTED[0].deeper == "nest"
assert data.NESTED[0].DEEPER == "nest"
data = DynaBox({"nested": BoxList([DynaBox({"deeper": "nest"})])})
assert data.nested[0].deeper == "nest"
assert data.NESTED[0].deeper == "nest"
assert isinstance(data.NESTED, BoxList)
assert isinstance(data.NESTED[0], DynaBox)
assert data.NESTED[0].DEEPER == "nest"
def __init__(self, settings_module=None, **kwargs): # pragma: no cover
"""Execute loaders and custom initialization
:param settings_module: defines the setttings file
:param kwargs: override default settings
"""
self._fresh = False
self._loaded_envs = []
self._loaded_hooks = defaultdict(dict)
self._loaded_py_modules = []
self._loaded_files = []
self._deleted = set()
self._store = DynaBox(box_settings=self)
self._env_cache = {}
self._loaded_by_loaders = {}
self._loaders = []
self._defaults = DynaBox(box_settings=self)
self.environ = os.environ
self.SETTINGS_MODULE = None
self.filter_strategy = kwargs.get("filter_strategy", None)
self._not_installed_warnings = []
self._validate_only = kwargs.pop("validate_only", None)
self._validate_exclude = kwargs.pop("validate_exclude", None)
self._validate_only_current_env = kwargs.pop(
"validate_only_current_env", False)
self.validators = ValidatorList(self,
validators=kwargs.pop(
"validators", None))
compat_kwargs(kwargs)
if settings_module:
self.set("SETTINGS_FILE_FOR_DYNACONF", settings_module)
for key, value in kwargs.items():
self.set(key, value)
# execute loaders only after setting defaults got from kwargs
self._defaults = kwargs
# The following flags are used for when copying of settings is done
skip_loaders = kwargs.get("dynaconf_skip_loaders", False)
skip_validators = kwargs.get("dynaconf_skip_validators", False)
if not skip_loaders:
self.execute_loaders()
if not skip_validators:
self.validators.validate(
only=self._validate_only,
exclude=self._validate_exclude,
only_current_env=self._validate_only_current_env,
)
def to_list(C): A=[] for B in C: if B is C:A.append(A) elif isinstance(B,box.Box):A.append(B.to_dict()) elif isinstance(B,BoxList):A.append(B.to_list()) else:A.append(B) return A
def __getitem__(B,item):
A=item
if B.box_options.get(_G)and isinstance(A,str)and A.startswith('['):
C=_list_pos_re.search(A);D=super(BoxList,B).__getitem__(int(C.groups()[0]))
if len(C.group())==len(A):return D
return D.__getitem__(A[len(C.group()):].lstrip('.'))
return super(BoxList,B).__getitem__(A)
def save_config():
"""Persist configuration settings to disk."""
# ref: https://dynaconf.readthedocs.io/en/docs_223/guides/advanced_usage.html#exporting
# ref: https://dynaconf.readthedocs.io/en/docs_223/reference/dynaconf.loaders.html#module-dynaconf.loaders.yaml_loader
file_to_save = get_config_file()
data = config.as_dict()
loaders.write(file_to_save, DynaBox(data).to_dict())
def set(self, key, value, loader_identifier=None, tomlfy=False):
"""Set a value storing references for the loader
:param key: The key to store
:param value: The value to store
:param loader_identifier: Optional loader name e.g: toml, yaml etc.
:param tomlfy: Bool define if value is parsed by toml (defaults False)
"""
value = parse_conf_data(value, tomlfy=tomlfy)
if isinstance(value, dict):
value = DynaBox(value, box_it_up=True)
key = key.strip().upper()
setattr(self, key, value)
self.store[key] = value
self._deleted.discard(key)
# set loader identifiers so cleaners know which keys to clean
if loader_identifier and loader_identifier in self.loaded_by_loaders:
self.loaded_by_loaders[loader_identifier][key] = value
elif loader_identifier:
self.loaded_by_loaders[loader_identifier] = {key: value}
elif loader_identifier is None:
# if .set is called without loader identifier it becomes
# a default value and goes away only when explicitly unset
self._defaults[key] = value
def _parse_conf_data(data, tomlfy=False, box_settings=None):
"""
@int @bool @float @json (for lists and dicts)
strings does not need converters
export DYNACONF_DEFAULT_THEME='material'
export DYNACONF_DEBUG='@bool True'
export DYNACONF_DEBUG_TOOLBAR_ENABLED='@bool False'
export DYNACONF_PAGINATION_PER_PAGE='@int 20'
export DYNACONF_MONGODB_SETTINGS='@json {"DB": "quokka_db"}'
export DYNACONF_ALLOWED_EXTENSIONS='@json ["jpg", "png"]'
"""
# not enforced to not break backwards compatibility with custom loaders
box_settings = box_settings or {}
cast_toggler = os.environ.get("AUTO_CAST_FOR_DYNACONF", "true").lower()
castenabled = cast_toggler not in false_values
if (castenabled and data and isinstance(data, str)
and data.startswith(tuple(converters.keys()))):
parts = data.partition(" ")
converter_key = parts[0]
value = parts[-1]
value = get_converter(converter_key, value, box_settings)
else:
value = parse_with_toml(data) if tomlfy else data
if isinstance(value, dict):
value = DynaBox(value, box_settings=box_settings)
return value
def __init__(self, settings_module=None, **kwargs): # pragma: no cover
"""Execute loaders and custom initialization
:param settings_module: defines the setttings file
:param kwargs: override default settings
"""
self._logger = None
self._fresh = False
self._loaded_envs = []
self._loaded_files = []
self._deleted = set()
self._store = DynaBox()
self._env_cache = {}
self._loaded_by_loaders = {}
self._loaders = []
self._defaults = {}
self.environ = os.environ
self.SETTINGS_MODULE = None
self._not_installed_warnings = []
self._memoized = None
compat_kwargs(kwargs)
if settings_module:
self.set("SETTINGS_FILE_FOR_DYNACONF", settings_module)
for key, value in kwargs.items():
self.set(key, value)
# execute loaders only after setting defaults got from kwargs
self._defaults = kwargs
self.logger.debug("Initializing Dynaconf (%s)", self._store)
self.execute_loaders()
def get(
self,
key,
default=None,
cast=None,
fresh=False,
dotted_lookup=True,
parent=None,
):
"""
Get a value from settings store, this is the prefered way to access::
>>> from dynaconf import settings
>>> settings.get('KEY')
:param key: The name of the setting value, will always be upper case
:param default: In case of not found it will be returned
:param cast: Should cast in to @int, @float, @bool or @json ?
:param fresh: Should reload from loaders store before access?
:param dotted_lookup: Should perform dotted-path lookup?
:param parent: Is there a pre-loaded parent in a nested data?
:return: The value if found, default or None
"""
nested_sep = self._store.get("NESTED_SEPARATOR_FOR_DYNACONF")
if nested_sep and nested_sep in key:
# turn FOO__bar__ZAZ in `FOO.bar.ZAZ`
key = key.replace(nested_sep, ".")
if "." in key and dotted_lookup:
return self._dotted_get(
dotted_key=key,
default=default,
cast=cast,
fresh=fresh,
parent=parent,
)
if default is not None:
# default values should behave exactly Dynaconf parsed values
if isinstance(default, list):
default = BoxList(default)
elif isinstance(default, dict):
default = DynaBox(default)
key = upperfy(key)
if key in self._deleted:
return default
if (
fresh
or self._fresh
or key in getattr(self, "FRESH_VARS_FOR_DYNACONF", ())
) and key not in UPPER_DEFAULT_SETTINGS:
self.unset(key)
self.execute_loaders(key=key)
data = (parent or self.store).get(key, default)
if cast:
data = get_converter(cast, data, box_settings=self)
return data
def setUpClass(cls):
# setup the backbone with a fan-in queue
config = DynaBox({
"rabbitmq": {
"host": "localhost",
"port": 35672,
"username": "******",
"password": "******",
"vhost": "/",
"exchange_name": "threatbus",
"queue": {
"name_join_symbol": ".",
"name_suffix": "threatbus",
"durable": False,
"auto_delete": True,
"exclusive": False,
"lazy": False,
"max_items": 10,
},
},
"console": False,
"file": False,
})
cls.inq = JoinableQueue()
plugin.run(config, config, cls.inq)
# subscribe this test case as concumer
cls.outq = JoinableQueue()
plugin.subscribe("stix2/indicator", cls.outq)
plugin.subscribe("stix2/sighting", cls.outq)
plugin.subscribe("threatbus/snapshotrequest", cls.outq)
plugin.subscribe("threatbus/snapshotenvelope", cls.outq)
time.sleep(1)
def _dotted_set(self, dotted_key, value, tomlfy=False, **kwargs):
"""Sets dotted keys as nested dictionaries.
Dotted set will always merge existing data, to avoid merging the
@reset token should be used.
Arguments:
dotted_key {str} -- A traversal name e.g: foo.bar.zaz
value {Any} -- The value to set to the nested value.
Keyword Arguments:
tomlfy {bool} -- Perform toml parsing (default: {False})
"""
split_keys = dotted_key.split(".")
existing_data = self.get(split_keys[0], {})
new_data = DynaBox(default_box=True)
tree = new_data
for k in split_keys[:-1]:
tree = tree.setdefault(k, {})
value = parse_conf_data(value, tomlfy=tomlfy)
tree[split_keys[-1]] = value
if existing_data:
object_merge({split_keys[0]: existing_data}, new_data)
self.update(data=new_data, tomlfy=tomlfy, **kwargs)
def __setitem__(B,key,value):
C=value;A=key
if B.box_options.get(_E):raise BoxError(_F)
if B.box_options.get(_G)and isinstance(A,str)and A.startswith('['):
D=_list_pos_re.search(A);E=int(D.groups()[0])
if len(D.group())==len(A):return super(BoxList,B).__setitem__(E,C)
return super(BoxList,B).__getitem__(E).__setitem__(A[len(D.group()):].lstrip('.'),C)
super(BoxList,B).__setitem__(A,C)
def export_to_file(self, file_path):
""" Export the settings to a file
:param file_path: path and name of the export file. The extensions be any out of
.yaml, .toml, .ini, .json, .py
"""
# generates a dict with all the keys for `development` env
data = self.as_dict()
loaders.write(file_path, DynaBox(data).to_dict(), env=self.current_env)
def write(filename, data, env=None):
"""Writes `data` to `filename` infers format by file extension."""
loader_name = "{0}_loader".format(filename.rpartition(".")[-1])
loader = globals().get(loader_name)
if not loader:
raise IOError("{0} cannot be found.".format(loader_name))
data = DynaBox(data).to_dict()
if loader is not py_loader and env and env not in data:
data = {env: data}
loader.write(filename, data, merge=False)
def write(filename, data, env=None):
"""Writes `data` to `filename` infers format by file extension."""
loader_name = f"{filename.rpartition('.')[-1]}_loader"
loader = globals().get(loader_name)
if not loader:
raise IOError(f"{loader_name} cannot be found.")
data = DynaBox(data, box_settings={}).to_dict()
if loader is not py_loader and env and env not in data:
data = {env: data}
loader.write(filename, data, merge=False)
def _dotted_set(self, dotted_key, value, tomlfy=False, **kwargs):
data = DynaBox(default_box=True)
tree = data
split_keys = dotted_key.split(".")
for k in split_keys[:-1]:
tree = tree.setdefault(k, {})
value = parse_conf_data(value, tomlfy=tomlfy)
tree[split_keys[-1]] = value
self.update(data=data, **kwargs)
def set(
self,
key,
value,
loader_identifier=None,
tomlfy=False,
dotted_lookup=True,
is_secret=False,
):
"""Set a value storing references for the loader
:param key: The key to store
:param value: The value to store
:param loader_identifier: Optional loader name e.g: toml, yaml etc.
:param tomlfy: Bool define if value is parsed by toml (defaults False)
:param is_secret: Bool define if secret values is hidden on logs.
"""
if "." in key and dotted_lookup is True:
return self._dotted_set(key,
value,
loader_identifier=loader_identifier,
tomlfy=tomlfy)
value = parse_conf_data(value, tomlfy=tomlfy)
key = key.strip().upper()
existing = getattr(self, key, None)
if existing is not None and existing != value:
value = self._merge_before_set(key, existing, value, is_secret)
if isinstance(value, dict):
value = DynaBox(value, box_it_up=True)
setattr(self, key, value)
self.store[key] = value
self._deleted.discard(key)
# set loader identifiers so cleaners know which keys to clean
if loader_identifier and loader_identifier in self.loaded_by_loaders:
self.loaded_by_loaders[loader_identifier][key] = value
elif loader_identifier:
self.loaded_by_loaders[loader_identifier] = {key: value}
elif loader_identifier is None:
# if .set is called without loader identifier it becomes
# a default value and goes away only when explicitly unset
self._defaults[key] = value
def to_toml(s: Settings) -> str:
"""convert dynaconf settings to a toml str"""
# we'll use the current public dynaconf api so that we don't need to import our own
# toml... that means we need to go via a temporary file to dump the current config,
# because dynaconf doesn't support it otherwise...
# github.com/rochacbruno/dynaconf/blob/68df27d2/dynaconf/loaders/toml_loader.py#L56
data = DynaBox(s.as_dict(internal=False))
# we create a temporary dir and write to a toml file
# note: this is to workaround the fact that using NamedTemporaryFile will
# error under windows due to loaders.write calling open on the file
with tempfile.TemporaryDirectory() as tmpdir:
fn = str(Path(tmpdir) / ".paquo.temporary.toml") # suffix determines loader
loaders.write(fn, to_kwargs(data))
with open(fn) as f:
output = f.read()
return output
def _parse_conf_data(data, tomlfy=False, box_settings=None):
"""
@int @bool @float @json (for lists and dicts)
strings does not need converters
export DYNACONF_DEFAULT_THEME='material'
export DYNACONF_DEBUG='@bool True'
export DYNACONF_DEBUG_TOOLBAR_ENABLED='@bool False'
export DYNACONF_PAGINATION_PER_PAGE='@int 20'
export DYNACONF_MONGODB_SETTINGS='@json {"DB": "quokka_db"}'
export DYNACONF_ALLOWED_EXTENSIONS='@json ["jpg", "png"]'
"""
# not enforced to not break backwards compatibility with custom loaders
box_settings = box_settings or {}
cast_toggler = os.environ.get("AUTO_CAST_FOR_DYNACONF", "true").lower()
castenabled = cast_toggler not in false_values
if (castenabled and data and isinstance(data, str)
and data.startswith(tuple(converters.keys()))):
# Check combination token is used
comb_token = re.match(r"^@(str|int|float|bool|json) @(jinja|format)",
data)
if comb_token:
tokens = comb_token.group(0)
converter_key_list = tokens.split(" ")
value = data.replace(tokens, "").strip()
else:
parts = data.partition(" ")
converter_key_list = [parts[0]]
value = parts[-1]
# Parse the converters iteratively
for converter_key in converter_key_list[::-1]:
value = get_converter(converter_key, value, box_settings)
else:
value = parse_with_toml(data) if tomlfy else data
if isinstance(value, dict):
value = DynaBox(value, box_settings=box_settings)
return value
def set(self, key, value, loader_identifier=None):
"""Set a value storing references for the loader"""
value = parse_conf_data(value)
if isinstance(value, dict):
value = DynaBox(value, box_it_up=True)
key = key.strip().upper()
setattr(self, key, value)
self.store[key] = value
self._deleted.discard(key)
# set loader identifiers so cleaners know which keys to clean
if loader_identifier and loader_identifier in self.loaded_by_loaders:
self.loaded_by_loaders[loader_identifier][key] = value
elif loader_identifier:
self.loaded_by_loaders[loader_identifier] = {key: value}
elif loader_identifier is None:
# if .set is called without loader identifier it becomes
# a default value and goes away only when explicitly unset
self._defaults[key] = value
def setUpClass(cls):
cls.host = "127.0.0.1"
cls.port = 47761
# setup the zeek plugin
config = DynaBox({
"zeek": {
"host": cls.host,
"port": cls.port,
"module_namespace": "Tenzir",
},
"console": False,
"file": False,
})
cls.inq = JoinableQueue()
cls.subscribe_callback = MagicMock()
cls.unsubscribe_callback = MagicMock()
plugin.run(config, config, cls.inq, cls.subscribe_callback,
cls.unsubscribe_callback)
time.sleep(0.3)
from dynaconf.utils.boxing import DynaBox
box = DynaBox(
{
"server": {
"HOST": "server.com",
"port": 8080,
"PARAMS": {
"username": "******",
"PASSWORD": "******",
"token": {
"TYPE": 1,
"value": 2
},
},
}
}, )
def test_datatypes():
assert isinstance(box.server, dict)
assert isinstance(box.server, DynaBox)
assert isinstance(box.server.host, str)
assert isinstance(box.server.PORT, int)
def test_access_lowercase():
assert box.server.host == "server.com"
assert box.server.port == 8080
assert box.server.params.username == "admin"
assert box.server.params.password == "secret"
def set(
self,
key,
value,
loader_identifier=None,
tomlfy=False,
dotted_lookup=True,
is_secret=False,
merge=False,
):
"""Set a value storing references for the loader
:param key: The key to store
:param value: The value to store
:param loader_identifier: Optional loader name e.g: toml, yaml etc.
:param tomlfy: Bool define if value is parsed by toml (defaults False)
:param is_secret: Bool define if secret values is hidden on logs.
:param merge: Bool define if existing nested data will be merged.
"""
nested_sep = self.get("NESTED_SEPARATOR_FOR_DYNACONF")
if nested_sep and nested_sep in key:
# turn FOO__bar__ZAZ in `FOO.bar.ZAZ`
key = key.replace(nested_sep, ".")
if "." in key and dotted_lookup is True:
return self._dotted_set(key,
value,
loader_identifier=loader_identifier,
tomlfy=tomlfy)
value = parse_conf_data(value, tomlfy=tomlfy)
key = upperfy(key.strip())
existing = getattr(self, key, None)
if getattr(value, "_dynaconf_del", None):
# just in case someone use a `@del` in a first level var.
self.unset(key, force=True)
return
if getattr(value, "_dynaconf_reset", False): # pragma: no cover
# just in case someone use a `@reset` in a first level var.
# NOTE: @reset/Reset is deprecated in v3.0.0
value = value.unwrap()
if getattr(value, "_dynaconf_merge", False):
# just in case someone use a `@merge` in a first level var
if existing:
object_merge(existing, value.unwrap())
value = value.unwrap()
if existing is not None and existing != value:
# `dynaconf_merge` used in file root `merge=True`
if merge:
object_merge(existing, value)
else:
# `dynaconf_merge` may be used within the key structure
value = self._merge_before_set(key, existing, value, is_secret)
if isinstance(value, dict):
value = DynaBox(value)
setattr(self, key, value)
self.store[key] = value
self._deleted.discard(key)
# set loader identifiers so cleaners know which keys to clean
if loader_identifier and loader_identifier in self.loaded_by_loaders:
self.loaded_by_loaders[loader_identifier][key] = value
elif loader_identifier:
self.loaded_by_loaders[loader_identifier] = {key: value}
elif loader_identifier is None:
# if .set is called without loader identifier it becomes
# a default value and goes away only when explicitly unset
self._defaults[key] = value
class Settings:
"""
Common logic for settings whether set by a module or by the user.
"""
dynaconf_banner = BANNER
def __init__(self, settings_module=None, **kwargs): # pragma: no cover
"""Execute loaders and custom initialization
:param settings_module: defines the setttings file
:param kwargs: override default settings
"""
self._fresh = False
self._loaded_envs = []
self._loaded_files = []
self._deleted = set()
self._store = DynaBox(box_settings=self)
self._env_cache = {}
self._loaded_by_loaders = {}
self._loaders = []
self._defaults = DynaBox(box_settings=self)
self.environ = os.environ
self.SETTINGS_MODULE = None
self._not_installed_warnings = []
self.validators = ValidatorList(
self, validators=kwargs.pop("validators", None)
)
compat_kwargs(kwargs)
if settings_module:
self.set("SETTINGS_FILE_FOR_DYNACONF", settings_module)
for key, value in kwargs.items():
self.set(key, value)
# execute loaders only after setting defaults got from kwargs
self._defaults = kwargs
self.execute_loaders()
self.validators.validate()
def __call__(self, *args, **kwargs):
"""Allow direct call of `settings('val')`
in place of `settings.get('val')`
"""
return self.get(*args, **kwargs)
def __setattr__(self, name, value):
"""Allow `settings.FOO = 'value'` while keeping internal attrs."""
if name in RESERVED_ATTRS:
super(Settings, self).__setattr__(name, value)
else:
self.set(name, value)
def __delattr__(self, name):
"""stores reference in `_deleted` for proper error management"""
self._deleted.add(name)
if hasattr(self, name):
super(Settings, self).__delattr__(name)
def __contains__(self, item):
"""Respond to `item in settings`"""
return item.upper() in self.store or item.lower() in self.store
def __getattribute__(self, name):
if name not in RESERVED_ATTRS and name not in UPPER_DEFAULT_SETTINGS:
with suppress(KeyError):
# self._store has Lazy values already evaluated
if (
name.islower()
and self._store.get("LOWERCASE_READ_FOR_DYNACONF", empty)
is False
):
# only matches exact casing, first levels always upper
return self._store.to_dict()[name]
# perform lookups for upper, and casefold
return self._store[name]
# in case of RESERVED_ATTRS or KeyError above, keep default behaviour
return super().__getattribute__(name)
def __getitem__(self, item):
"""Allow getting variables as dict keys `settings['KEY']`"""
value = self.get(item, default=empty)
if value is empty:
raise KeyError(f"{item} does not exist")
return value
def __setitem__(self, key, value):
"""Allow `settings['KEY'] = 'value'`"""
self.set(key, value)
@property
def store(self):
"""Gets internal storage"""
return self._store
def __dir__(self):
"""Enable auto-complete for code editors"""
return (
RESERVED_ATTRS
+ [k.lower() for k in self.keys()]
+ list(self.keys())
)
def __iter__(self):
"""Redirects to store object"""
yield from self._store
def items(self):
"""Redirects to store object"""
return self._store.items()
def keys(self):
"""Redirects to store object"""
return self.store.keys()
def values(self):
"""Redirects to store object"""
return self.store.values()
def setdefault(self, item, default):
"""Returns value if exists or set it as the given default"""
value = self.get(item, empty)
if value is empty and default is not empty:
self.set(
item,
default,
loader_identifier="setdefault",
tomlfy=True,
dotted_lookup=True,
)
return default
return value
def as_dict(self, env=None, internal=False):
"""Returns a dictionary with set key and values.
:param env: Str env name, default self.current_env `DEVELOPMENT`
:param internal: bool - should include dynaconf internal vars?
"""
ctx_mgr = suppress() if env is None else self.using_env(env)
with ctx_mgr:
data = self.store.to_dict().copy()
# if not internal remove internal settings
if not internal:
for name in UPPER_DEFAULT_SETTINGS:
data.pop(name, None)
return data
to_dict = as_dict # backwards compatibility
def _dotted_get(
self, dotted_key, default=None, parent=None, cast=None, **kwargs
):
"""
Perform dotted key lookups and keep track of where we are.
:param key: The name of the setting value, will always be upper case
:param default: In case of not found it will be returned
:param parent: Is there a pre-loaded parent in a nested data?
"""
split_key = dotted_key.split(".")
name, keys = split_key[0], split_key[1:]
result = self.get(name, default=default, parent=parent, **kwargs)
# If we've reached the end, or parent key not found, then return result
if not keys or result == default:
if cast and cast in converters:
return get_converter(cast, result, box_settings=self)
elif cast is True:
return parse_conf_data(result, tomlfy=True, box_settings=self)
return result
# If we've still got key elements to traverse, let's do that.
return self._dotted_get(
".".join(keys), default=default, parent=result, cast=cast, **kwargs
)
def get(
self,
key,
default=None,
cast=None,
fresh=False,
dotted_lookup=True,
parent=None,
):
"""
Get a value from settings store, this is the prefered way to access::
>>> from dynaconf import settings
>>> settings.get('KEY')
:param key: The name of the setting value, will always be upper case
:param default: In case of not found it will be returned
:param cast: Should cast in to @int, @float, @bool or @json ?
:param fresh: Should reload from loaders store before access?
:param dotted_lookup: Should perform dotted-path lookup?
:param parent: Is there a pre-loaded parent in a nested data?
:return: The value if found, default or None
"""
nested_sep = self._store.get("NESTED_SEPARATOR_FOR_DYNACONF")
if nested_sep and nested_sep in key:
# turn FOO__bar__ZAZ in `FOO.bar.ZAZ`
key = key.replace(nested_sep, ".")
if "." in key and dotted_lookup:
return self._dotted_get(
dotted_key=key,
default=default,
cast=cast,
fresh=fresh,
parent=parent,
)
if default is not None:
# default values should behave exactly Dynaconf parsed values
if isinstance(default, list):
default = BoxList(default)
elif isinstance(default, dict):
default = DynaBox(default)
key = upperfy(key)
if key in self._deleted:
return default
if (
fresh
or self._fresh
or key in getattr(self, "FRESH_VARS_FOR_DYNACONF", ())
) and key not in UPPER_DEFAULT_SETTINGS:
self.unset(key)
self.execute_loaders(key=key)
data = (parent or self.store).get(key, default)
if cast:
data = get_converter(cast, data, box_settings=self)
return data
def exists(self, key, fresh=False):
"""Check if key exists
:param key: the name of setting variable
:param fresh: if key should be taken from source direclty
:return: Boolean
"""
key = upperfy(key)
if key in self._deleted:
return False
return self.get(key, fresh=fresh, default=missing) is not missing
def get_fresh(self, key, default=None, cast=None):
"""This is a shortcut to `get(key, fresh=True)`. always reload from
loaders store before getting the var.
:param key: The name of the setting value, will always be upper case
:param default: In case of not found it will be returned
:param cast: Should cast in to @int, @float, @bool or @json ?
:return: The value if found, default or None
"""
return self.get(key, default=default, cast=cast, fresh=True)
def get_environ(self, key, default=None, cast=None):
"""Get value from environment variable using os.environ.get
:param key: The name of the setting value, will always be upper case
:param default: In case of not found it will be returned
:param cast: Should cast in to @int, @float, @bool or @json ?
or cast must be true to use cast inference
:return: The value if found, default or None
"""
key = upperfy(key)
data = self.environ.get(key, default)
if data:
if cast in converters:
data = get_converter(cast, data, box_settings=self)
elif cast is True:
data = parse_conf_data(data, tomlfy=True, box_settings=self)
return data
def exists_in_environ(self, key):
"""Return True if env variable is exported"""
return upperfy(key) in self.environ
def as_bool(self, key):
"""Partial method for get with bool cast"""
return self.get(key, cast="@bool")
def as_int(self, key):
"""Partial method for get with int cast"""
return self.get(key, cast="@int")
def as_float(self, key):
"""Partial method for get with float cast"""
return self.get(key, cast="@float")
def as_json(self, key):
"""Partial method for get with json cast"""
return self.get(key, cast="@json")
@property
def loaded_envs(self):
"""Get or create internal loaded envs list"""
if not self._loaded_envs:
self._loaded_envs = []
return self._loaded_envs
# compat
loaded_namespaces = loaded_envs
@loaded_envs.setter
def loaded_envs(self, value):
"""Setter for env list"""
self._loaded_envs = value
@property
def loaded_by_loaders(self):
"""Gets the internal mapping of LOADER -> values"""
return self._loaded_by_loaders
def from_env(self, env="", keep=False, **kwargs):
"""Return a new isolated settings object pointing to specified env.
Example of settings.toml::
[development]
message = 'This is in dev'
[other]
message = 'this is in other env'
Program::
>>> from dynaconf import settings
>>> print(settings.MESSAGE)
'This is in dev'
>>> print(settings.from_env('other').MESSAGE)
'This is in other env'
# The existing settings object remains the same.
>>> print(settings.MESSAGE)
'This is in dev'
Arguments:
env {str} -- Env to load (development, production, custom)
Keyword Arguments:
keep {bool} -- Keep pre-existing values (default: {False})
kwargs {dict} -- Passed directly to new instance.
"""
cache_key = f"{env}_{keep}_{kwargs}"
if cache_key in self._env_cache:
return self._env_cache[cache_key]
new_data = {
key: self.get(key)
for key in UPPER_DEFAULT_SETTINGS
if key not in RENAMED_VARS
}
# This is here for backwards compatibility
# To be removed on 4.x.x
default_settings_paths = self.get("default_settings_paths")
if default_settings_paths: # pragma: no cover
new_data["default_settings_paths"] = default_settings_paths
if keep:
# keep existing values from current env
new_data.update(
{
key: value
for key, value in self.store.to_dict().copy().items()
if key.isupper() and key not in RENAMED_VARS
}
)
new_data.update(kwargs)
new_data["FORCE_ENV_FOR_DYNACONF"] = env
new_settings = LazySettings(**new_data)
self._env_cache[cache_key] = new_settings
return new_settings
@contextmanager
def using_env(self, env, clean=True, silent=True, filename=None):
"""
This context manager allows the contextual use of a different env
Example of settings.toml::
[development]
message = 'This is in dev'
[other]
message = 'this is in other env'
Program::
>>> from dynaconf import settings
>>> print settings.MESSAGE
'This is in dev'
>>> with settings.using_env('OTHER'):
... print settings.MESSAGE
'this is in other env'
:param env: Upper case name of env without any _
:param clean: If preloaded vars should be cleaned
:param silent: Silence errors
:param filename: Custom filename to load (optional)
:return: context
"""
try:
self.setenv(env, clean=clean, silent=silent, filename=filename)
yield
finally:
if env.lower() != self.ENV_FOR_DYNACONF.lower():
del self.loaded_envs[-1]
self.setenv(self.current_env, clean=clean, filename=filename)
# compat
using_namespace = using_env
@contextmanager
def fresh(self):
"""
this context manager force the load of a key direct from the store::
$ export DYNACONF_VALUE='Original'
>>> from dynaconf import settings
>>> print settings.VALUE
'Original'
$ export DYNACONF_VALUE='Changed Value'
>>> print settings.VALUE # will not be reloaded from env vars
'Original
>>> with settings.fresh(): # inside this context all is reloaded
... print settings.VALUE
'Changed Value'
an alternative is using `settings.get_fresh(key)`
:return: context
"""
self._fresh = True
yield
self._fresh = False
@property
def current_env(self):
"""Return the current active env"""
if self.ENVIRONMENTS_FOR_DYNACONF is False:
return "main"
if self.FORCE_ENV_FOR_DYNACONF is not None:
return self.FORCE_ENV_FOR_DYNACONF
try:
return self.loaded_envs[-1]
except IndexError:
return self.ENV_FOR_DYNACONF
# compat
current_namespace = current_env
@property
def settings_module(self):
"""Gets SETTINGS_MODULE variable"""
settings_module = parse_conf_data(
os.environ.get(
self.ENVVAR_FOR_DYNACONF, self.SETTINGS_FILE_FOR_DYNACONF
),
tomlfy=True,
box_settings=self,
)
if settings_module != getattr(self, "SETTINGS_MODULE", None):
self.set("SETTINGS_MODULE", settings_module)
# This is for backewards compatibility, to be removed on 4.x.x
if not self.SETTINGS_MODULE and self.get("default_settings_paths"):
self.SETTINGS_MODULE = self.get("default_settings_paths")
return self.SETTINGS_MODULE
# Backwards compatibility see #169
settings_file = settings_module
def setenv(self, env=None, clean=True, silent=True, filename=None):
"""Used to interactively change the env
Example of settings.toml::
[development]
message = 'This is in dev'
[other]
message = 'this is in other env'
Program::
>>> from dynaconf import settings
>>> print settings.MESSAGE
'This is in dev'
>>> with settings.using_env('OTHER'):
... print settings.MESSAGE
'this is in other env'
:param env: Upper case name of env without any _
:param clean: If preloaded vars should be cleaned
:param silent: Silence errors
:param filename: Custom filename to load (optional)
:return: context
"""
env = env or self.ENV_FOR_DYNACONF
if not isinstance(env, str):
raise AttributeError("env should be a string")
env = env.upper()
if env != self.ENV_FOR_DYNACONF:
self.loaded_envs.append(env)
else:
self.loaded_envs = []
if clean:
self.clean(env=env)
self.execute_loaders(env=env, silent=silent, filename=filename)
# compat
namespace = setenv
def clean(self, *args, **kwargs):
"""Clean all loaded values to reload when switching envs"""
for key in list(self.store.keys()):
self.unset(key)
def unset(self, key, force=False):
"""Unset on all references
:param key: The key to be unset
:param force: Bypass default checks and force unset
"""
key = upperfy(key.strip())
if (
key not in UPPER_DEFAULT_SETTINGS
and key not in self._defaults
or force
):
with suppress(KeyError, AttributeError):
# AttributeError can happen when a LazyValue consumes
# a previously deleted key
delattr(self, key)
del self.store[key]
def unset_all(self, keys, force=False): # pragma: no cover
"""Unset based on a list of keys
:param keys: a list of keys
:param force: Bypass default checks and force unset
"""
for key in keys:
self.unset(key, force=force)
def _dotted_set(self, dotted_key, value, tomlfy=False, **kwargs):
"""Sets dotted keys as nested dictionaries.
Dotted set will always reassign the value, to merge use `@merge` token
Arguments:
dotted_key {str} -- A traversal name e.g: foo.bar.zaz
value {Any} -- The value to set to the nested value.
Keyword Arguments:
tomlfy {bool} -- Perform toml parsing (default: {False})
"""
split_keys = dotted_key.split(".")
existing_data = self.get(split_keys[0], {})
new_data = tree = DynaBox(box_settings=self)
for k in split_keys[:-1]:
tree = tree.setdefault(k, {})
value = parse_conf_data(value, tomlfy=tomlfy, box_settings=self)
tree[split_keys[-1]] = value
if existing_data:
new_data = object_merge(
old=DynaBox({split_keys[0]: existing_data}),
new=new_data,
full_path=split_keys,
)
self.update(data=new_data, tomlfy=tomlfy, **kwargs)
def set(
self,
key,
value,
loader_identifier=None,
tomlfy=False,
dotted_lookup=True,
is_secret="DeprecatedArgument", # noqa
merge=False,
):
"""Set a value storing references for the loader
:param key: The key to store
:param value: The value to store
:param loader_identifier: Optional loader name e.g: toml, yaml etc.
:param tomlfy: Bool define if value is parsed by toml (defaults False)
:param merge: Bool define if existing nested data will be merged.
"""
nested_sep = self.get("NESTED_SEPARATOR_FOR_DYNACONF")
if nested_sep and nested_sep in key:
# turn FOO__bar__ZAZ in `FOO.bar.ZAZ`
key = key.replace(nested_sep, ".")
if "." in key and dotted_lookup is True:
return self._dotted_set(
key, value, loader_identifier=loader_identifier, tomlfy=tomlfy
)
value = parse_conf_data(value, tomlfy=tomlfy, box_settings=self)
key = upperfy(key.strip())
existing = getattr(self, key, None)
if getattr(value, "_dynaconf_del", None):
# just in case someone use a `@del` in a first level var.
self.unset(key, force=True)
return
if getattr(value, "_dynaconf_reset", False): # pragma: no cover
# just in case someone use a `@reset` in a first level var.
# NOTE: @reset/Reset is deprecated in v3.0.0
value = value.unwrap()
if getattr(value, "_dynaconf_merge", False):
# just in case someone use a `@merge` in a first level var
if existing:
value = object_merge(existing, value.unwrap())
else:
value = value.unwrap()
if existing is not None and existing != value:
# `dynaconf_merge` used in file root `merge=True`
if merge:
value = object_merge(existing, value)
else:
# `dynaconf_merge` may be used within the key structure
value = self._merge_before_set(existing, value)
if isinstance(value, dict):
value = DynaBox(value, box_settings=self)
self.store[key] = value
self._deleted.discard(key)
super(Settings, self).__setattr__(key, value)
# set loader identifiers so cleaners know which keys to clean
if loader_identifier and loader_identifier in self.loaded_by_loaders:
self.loaded_by_loaders[loader_identifier][key] = value
elif loader_identifier:
self.loaded_by_loaders[loader_identifier] = {key: value}
elif loader_identifier is None:
# if .set is called without loader identifier it becomes
# a default value and goes away only when explicitly unset
self._defaults[key] = value
def update(
self,
data=None,
loader_identifier=None,
tomlfy=False,
merge=False,
is_secret="DeprecatedArgument", # noqa
**kwargs,
):
"""
Update values in the current settings object without saving in stores::
>>> from dynaconf import settings
>>> print settings.NAME
'Bruno'
>>> settings.update({'NAME': 'John'}, other_value=1)
>>> print settings.NAME
'John'
>>> print settings.OTHER_VALUE
1
:param data: Data to be updated
:param loader_identifier: Only to be used by custom loaders
:param tomlfy: Bool define if value is parsed by toml (defaults False)
:param merge: Bool define if existing nested data will be merged.
:param kwargs: extra values to update
:return: None
"""
data = data or {}
data.update(kwargs)
for key, value in data.items():
self.set(
key,
value,
loader_identifier=loader_identifier,
tomlfy=tomlfy,
merge=merge,
)
def _merge_before_set(self, existing, value):
"""Merge the new value being set with the existing value before set"""
global_merge = getattr(self, "MERGE_ENABLED_FOR_DYNACONF", False)
if isinstance(value, dict):
local_merge = value.pop(
"dynaconf_merge", value.pop("dynaconf_merge_unique", None)
)
if local_merge not in (True, False, None) and not value:
# In case `dynaconf_merge:` holds value not boolean - ref #241
value = local_merge
if global_merge or local_merge:
value = object_merge(existing, value)
if isinstance(value, (list, tuple)):
local_merge = (
"dynaconf_merge" in value or "dynaconf_merge_unique" in value
)
if global_merge or local_merge:
value = list(value)
unique = False
if local_merge:
try:
value.remove("dynaconf_merge")
except ValueError: # EAFP
value.remove("dynaconf_merge_unique")
unique = True
value = object_merge(existing, value, unique=unique)
return value
@property
def loaders(self): # pragma: no cover
"""Return available loaders"""
if self.LOADERS_FOR_DYNACONF in (None, 0, "0", "false", False):
return []
if not self._loaders:
for loader_module_name in self.LOADERS_FOR_DYNACONF:
loader = importlib.import_module(loader_module_name)
self._loaders.append(loader)
return self._loaders
def reload(self, env=None, silent=None): # pragma: no cover
"""Clean end Execute all loaders"""
self.clean()
self.execute_loaders(env, silent)
def execute_loaders(
self, env=None, silent=None, key=None, filename=None, loaders=None
):
"""Execute all internal and registered loaders
:param env: The environment to load
:param silent: If loading erros is silenced
:param key: if provided load a single key
:param filename: optional custom filename to load
:param loaders: optional list of loader modules
"""
if key is None:
default_loader(self, self._defaults)
env = (env or self.current_env).upper()
silent = silent or self.SILENT_ERRORS_FOR_DYNACONF
if loaders is None:
self.pre_load(env, silent=silent, key=key)
settings_loader(
self, env=env, silent=silent, key=key, filename=filename
)
self.load_extra_yaml(env, silent, key) # DEPRECATED
enable_external_loaders(self)
loaders = self.loaders
for loader in loaders:
loader.load(self, env, silent=silent, key=key)
self.load_includes(env, silent=silent, key=key)
def pre_load(self, env, silent, key):
"""Do we have any file to pre-load before main settings file?"""
preloads = self.get("PRELOAD_FOR_DYNACONF", [])
if preloads:
self.load_file(path=preloads, env=env, silent=silent, key=key)
def load_includes(self, env, silent, key):
"""Do we have any nested includes we need to process?"""
includes = self.get("DYNACONF_INCLUDE", [])
includes.extend(ensure_a_list(self.get("INCLUDES_FOR_DYNACONF")))
if includes:
self.load_file(path=includes, env=env, silent=silent, key=key)
# ensure env vars are the last thing loaded after all includes
last_loader = self.loaders and self.loaders[-1]
if last_loader and last_loader == env_loader:
last_loader.load(self, env, silent, key)
def load_file(self, path=None, env=None, silent=True, key=None):
"""Programmatically load files from ``path``.
:param path: A single filename or a file list
:param env: Which env to load from file (default current_env)
:param silent: Should raise errors?
:param key: Load a single key?
"""
env = (env or self.current_env).upper()
files = ensure_a_list(path)
if files:
already_loaded = set()
for _filename in files:
if py_loader.try_to_load_from_py_module_name(
obj=self, name=_filename, silent=True
):
# if it was possible to load from module name
# continue the loop.
continue
# python 3.6 does not resolve Pathlib basedirs
# issue #494
root_dir = str(self._root_path or os.getcwd())
if (
isinstance(_filename, Path)
and str(_filename.parent) in root_dir
): # pragma: no cover
filepath = str(_filename)
else:
filepath = os.path.join(
self._root_path or os.getcwd(), str(_filename)
)
paths = [
p
for p in sorted(glob.glob(filepath))
if ".local." not in p
]
local_paths = [
p for p in sorted(glob.glob(filepath)) if ".local." in p
]
# Handle possible *.globs sorted alphanumeric
for path in paths + local_paths:
if path in already_loaded: # pragma: no cover
continue
settings_loader(
obj=self,
env=env,
silent=silent,
key=key,
filename=path,
)
already_loaded.add(path)
@property
def _root_path(self):
"""ROOT_PATH_FOR_DYNACONF or the path of first loaded file or '.'"""
if self.ROOT_PATH_FOR_DYNACONF is not None:
return self.ROOT_PATH_FOR_DYNACONF
if self._loaded_files: # called once
root_path = os.path.dirname(self._loaded_files[0])
self.set("ROOT_PATH_FOR_DYNACONF", root_path)
return root_path
def load_extra_yaml(self, env, silent, key):
"""This is deprecated, kept for compat
.. deprecated:: 1.0.0
Use multiple settings or INCLUDES_FOR_DYNACONF files instead.
"""
if self.get("YAML") is not None:
warnings.warn(
"The use of YAML var is deprecated, please define multiple "
"filepaths instead: "
"e.g: SETTINGS_FILE_FOR_DYNACONF = "
"'settings.py,settings.yaml,settings.toml' or "
"INCLUDES_FOR_DYNACONF=['path.toml', 'folder/*']"
)
yaml_loader.load(
self,
env=env,
filename=self.find_file(self.get("YAML")),
silent=silent,
key=key,
)
def path_for(self, *args):
"""Path containing _root_path"""
if args and args[0].startswith(os.path.sep):
return os.path.join(*args)
return os.path.join(self._root_path or os.getcwd(), *args)
def find_file(self, *args, **kwargs):
kwargs.setdefault("project_root", self._root_path)
kwargs.setdefault(
"skip_files", self.get("SKIP_FILES_FOR_DYNACONF", [])
)
return find_file(*args, **kwargs)
def flag(self, key, env=None):
"""Feature flagging system
write flags to redis
$ dynaconf write redis -s DASHBOARD=1 -e premiumuser
meaning: Any premium user has DASHBOARD feature enabled
In your program do::
# premium user has access to dashboard?
>>> if settings.flag('dashboard', 'premiumuser'):
... activate_dashboard()
The value is ensured to be loaded fresh from redis server
It also works with file settings but the recommended is redis
as the data can be loaded once it is updated.
:param key: The flag name
:param env: The env to look for
"""
env = env or self.ENVVAR_PREFIX_FOR_DYNACONF or "DYNACONF"
with self.using_env(env):
value = self.get_fresh(key)
return value is True or value in true_values
def populate_obj(self, obj, keys=None, ignore=None):
"""Given the `obj` populate it using self.store items.
:param obj: An object to be populated, a class instance.
:param keys: A list of keys to be included.
:param ignore: A list of keys to be excluded.
"""
keys = keys or self.keys()
for key in keys:
key = upperfy(key)
if ignore and key in ignore:
continue
value = self.get(key, empty)
if value is not empty:
setattr(obj, key, value)
def dynaconf(self): # pragma: no cover
"""A proxy to access internal methods and attributes
Starting in 3.0.0 Dynaconf now allows first level lower case
keys that are not reserved keyword, so this is a proxy to
internal methods and attrs.
"""
return # TOBE IMPLEMENTED
@property
def logger(self): # pragma: no cover
"""backwards compatibility with pre 3.0 loaders
In dynaconf 3.0.0 logger and debug messages has been removed.
"""
warnings.warn(
"logger and DEBUG messages has been removed on dynaconf 3.0.0"
)
import logging # noqa
return logging.getLogger("dynaconf")
def is_overridden(self, setting): # noqa
"""This is to provide Django DJDT support: issue 382"""
return False
