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
|
import json
import os
import re
import warnings
from functools import wraps
from dynaconf.utils import extract_json_objects
from dynaconf.utils import isnamedtupleinstance
from dynaconf.utils import multi_replace
from dynaconf.utils import recursively_evaluate_lazy_format
from dynaconf.utils.boxing import DynaBox
from dynaconf.vendor import toml
try:
from jinja2 import Environment
jinja_env = Environment()
for p_method in ("abspath", "realpath", "relpath", "dirname", "basename"):
jinja_env.filters[p_method] = getattr(os.path, p_method)
except ImportError: # pragma: no cover
jinja_env = None
true_values = ("t", "true", "enabled", "1", "on", "yes", "True")
false_values = ("f", "false", "disabled", "0", "off", "no", "False", "")
KV_PATTERN = re.compile(r"([a-zA-Z0-9 ]*=[a-zA-Z0-9\- :]*)")
"""matches `a=b, c=d, e=f` used on `VALUE='@merge foo=bar'` variables."""
class DynaconfParseError(Exception):
"""Error to raise when parsing @casts"""
class MetaValue:
"""A Marker to trigger specific actions on `set` and `object_merge`"""
_meta_value = True
def __init__(self, value, box_settings):
self.box_settings = box_settings
self.value = parse_conf_data(
value, tomlfy=True, box_settings=box_settings
)
def __repr__(self):
return f"{self.__class__.__name__}({self.value}) on {id(self)}"
def unwrap(self):
return self.value
class Reset(MetaValue):
"""Triggers an existing key to be reset to its value
NOTE: DEPRECATED on v3.0.0
"""
_dynaconf_reset = True
def __init__(self, value, box_settings):
self.box_settings = box_settings
self.value = parse_conf_data(
value, tomlfy=True, box_settings=self.box_settings
)
warnings.warn(f"{self.value} does not need `@reset` anymore.")
class Del(MetaValue):
"""Triggers an existing key to be deleted"""
_dynaconf_del = True
def unwrap(self):
raise ValueError("Del object has no value")
class Merge(MetaValue):
"""Triggers an existing key to be merged"""
_dynaconf_merge = True
def __init__(self, value, box_settings, unique=False):
self.box_settings = box_settings
self.value = parse_conf_data(
value, tomlfy=True, box_settings=box_settings
)
if isinstance(self.value, (int, float, bool)):
# @merge 1, @merge 1.1, @merge False
self.value = [self.value]
elif isinstance(self.value, str):
# @merge {"valid": "json"}
json_object = list(
extract_json_objects(
multi_replace(
self.value,
{
": True": ": true",
":True": ": true",
": False": ": false",
":False": ": false",
": None": ": null",
":None": ": null",
},
)
)
)
if len(json_object) == 1:
self.value = json_object[0]
else:
matches = KV_PATTERN.findall(self.value)
# a=b, c=d
if matches:
self.value = {
k.strip(): parse_conf_data(
v, tomlfy=True, box_settings=box_settings
)
for k, v in (
match.strip().split("=") for match in matches
)
}
elif "," in self.value:
# @merge foo,bar
self.value = self.value.split(",")
else:
# @merge foo
self.value = [self.value]
self.unique = unique
class BaseFormatter:
def __init__(self, function, token):
self.function = function
self.token = token
def __call__(self, value, **context):
return self.function(value, **context)
def __str__(self):
return str(self.token)
def _jinja_formatter(value, **context):
if jinja_env is None: # pragma: no cover
raise ImportError(
"jinja2 must be installed to enable '@jinja' settings in dynaconf"
)
return jinja_env.from_string(value).render(**context)
class Formatters:
"""Dynaconf builtin formatters"""
python_formatter = BaseFormatter(str.format, "format")
jinja_formatter = BaseFormatter(_jinja_formatter, "jinja")
class Lazy:
"""Holds data to format lazily."""
_dynaconf_lazy_format = True
def __init__(self, value, formatter=Formatters.python_formatter):
self.value = value
self.formatter = formatter
@property
def context(self):
"""Builds a context for formatting."""
return {"env": os.environ, "this": self.settings}
def __call__(self, settings):
"""LazyValue triggers format lazily."""
self.settings = settings
return self.formatter(self.value, **self.context)
def __str__(self):
"""Gives string representation for the object."""
return str(self.value)
def __repr__(self):
"""Give the quoted str representation"""
return f"'@{self.formatter} {self.value}'"
def _dynaconf_encode(self):
"""Encodes this object values to be serializable to json"""
return f"@{self.formatter} {self.value}"
def try_to_encode(value, callback=str):
"""Tries to encode a value by verifying existence of `_dynaconf_encode`"""
try:
return value._dynaconf_encode()
except (AttributeError, TypeError):
return callback(value)
def evaluate_lazy_format(f):
"""Marks a method on Settings instance to
lazily evaluate LazyFormat objects upon access."""
@wraps(f)
def evaluate(settings, *args, **kwargs):
value = f(settings, *args, **kwargs)
return recursively_evaluate_lazy_format(value, settings)
return evaluate
converters = {
"@str": str,
"@int": int,
"@float": float,
"@bool": lambda value: str(value).lower() in true_values,
"@json": json.loads,
"@format": lambda value: Lazy(value),
"@jinja": lambda value: Lazy(value, formatter=Formatters.jinja_formatter),
# Meta Values to trigger pre assignment actions
"@reset": Reset, # @reset is DEPRECATED on v3.0.0
"@del": Del,
"@merge": Merge,
"@merge_unique": lambda value, box_settings: Merge(
value, box_settings, unique=True
),
# Special markers to be used as placeholders e.g: in prefilled forms
# will always return None when evaluated
"@note": lambda value: None,
"@comment": lambda value: None,
"@null": lambda value: None,
"@none": lambda value: None,
}
def get_converter(converter_key, value, box_settings):
converter = converters[converter_key]
try:
converted_value = converter(value, box_settings=box_settings)
except TypeError:
converted_value = converter(value)
return converted_value
def parse_with_toml(data):
"""Uses TOML syntax to parse data"""
try:
return toml.loads(f"key={data}")["key"]
except (toml.TomlDecodeError, KeyError):
return data
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 parse_conf_data(data, tomlfy=False, box_settings=None):
# fix for https://github.com/rochacbruno/dynaconf/issues/595
if isnamedtupleinstance(data):
return data
# not enforced to not break backwards compatibility with custom loaders
box_settings = box_settings or {}
if isinstance(data, (tuple, list)):
# recursively parse each sequence item
return [
parse_conf_data(item, tomlfy=tomlfy, box_settings=box_settings)
for item in data
]
if isinstance(data, (dict, DynaBox)):
# recursively parse inner dict items
_parsed = {}
for k, v in data.items():
_parsed[k] = parse_conf_data(
v, tomlfy=tomlfy, box_settings=box_settings
)
return _parsed
# return parsed string value
return _parse_conf_data(data, tomlfy=tomlfy, box_settings=box_settings)
def unparse_conf_data(value):
if isinstance(value, bool):
return f"@bool {value}"
if isinstance(value, int):
return f"@int {value}"
if isinstance(value, float):
return f"@float {value}"
if isinstance(value, (list, dict)):
return f"@json {json.dumps(value)}"
if isinstance(value, Lazy):
return try_to_encode(value)
if value is None:
return "@none "
return value
|