dynaconf 3.2.5__tar.gz → 3.2.7__tar.gz

{dynaconf-3.2.5 → dynaconf-3.2.7}/CHANGELOG.md

@@ -2,6 +2,29 @@ Changelog
 =========
 
 <!-- insertion marker -->
+## [3.2.7](https://github.com/dynaconf/dynaconf/releases/tag/3.2.7) - 2025-01-21
+
+### Bug Fixes
+
+- lazy validator's default value would evaluate early (#1198). *By Pedro Brochado*.
+- Fixed an error that would raise when using get_history() with lazy values (#1184) (#1185). *By Pedro Brochado*.
+- Fixed Redis loader when ENV prefix is `None`.
+- Populate object method now takes `internal` attribute to filter out internal variables.
+- On CLI `json.dumps` defaults to `repr` for types that cannot be serialized.
+- Added an identifier to validator calls of `set` method
+- Fix django app discovery using DJANGO_SETTINGS_MODULE variable
+
+### Features
+
+- Added `@insert` token to call `list.insert`
+- Allow env loader to load from multiple prefixes
+- Allow multiple composable current environments
+- Track more data on `load_file` method
+- Added `--json` to dynaconf list CLI
+
+
+## [3.2.6](https://github.com/dynaconf/dynaconf/releases/tag/3.2.6) - 2024-07-19
+
 ## [3.2.5](https://github.com/pedro-psb/dynaconf/releases/tag/3.2.5) - 2024-03-18
 
 ### Bug Fixes

{dynaconf-3.2.5 → dynaconf-3.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dynaconf
-Version: 3.2.5
+Version: 3.2.7
 Summary: The dynamic configurator for your Python Project
 Home-page: https://github.com/dynaconf/dynaconf
 Author: Bruno Rocha
@@ -26,6 +26,14 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+Provides-Extra: redis
+Provides-Extra: vault
+Provides-Extra: yaml
+Provides-Extra: toml
+Provides-Extra: ini
+Provides-Extra: configobj
+Provides-Extra: all
+Provides-Extra: test
 License-File: LICENSE
 License-File: vendor_licenses/box-LICENSE.txt
 License-File: vendor_licenses/click-LICENSE.rst
@@ -35,36 +43,6 @@ License-File: vendor_licenses/ruamel.yaml-LICENSE.txt
 License-File: vendor_licenses/toml-LICENSE.txt
 License-File: vendor_licenses/tomli-LICENSE.txt
 License-File: vendor_licenses/vendor_versions.txt
-Provides-Extra: redis
-Requires-Dist: redis; extra == "redis"
-Provides-Extra: vault
-Requires-Dist: hvac; extra == "vault"
-Provides-Extra: yaml
-Requires-Dist: ruamel.yaml; extra == "yaml"
-Provides-Extra: toml
-Requires-Dist: toml; extra == "toml"
-Provides-Extra: ini
-Requires-Dist: configobj; extra == "ini"
-Provides-Extra: configobj
-Requires-Dist: configobj; extra == "configobj"
-Provides-Extra: all
-Requires-Dist: redis; extra == "all"
-Requires-Dist: ruamel.yaml; extra == "all"
-Requires-Dist: configobj; extra == "all"
-Requires-Dist: hvac; extra == "all"
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: pytest-xdist; extra == "test"
-Requires-Dist: pytest-mock; extra == "test"
-Requires-Dist: radon; extra == "test"
-Requires-Dist: flask>=0.12; extra == "test"
-Requires-Dist: django; extra == "test"
-Requires-Dist: python-dotenv; extra == "test"
-Requires-Dist: toml; extra == "test"
-Requires-Dist: redis; extra == "test"
-Requires-Dist: hvac>=1.1.0; extra == "test"
-Requires-Dist: configobj; extra == "test"
 
 <!-- [![Dynaconf](docs/img/logo_400.svg?sanitize=true)](http://dynaconf.com) -->
 

dynaconf-3.2.7/dynaconf/VERSION

@@ -0,0 +1 @@
+3.2.7

{dynaconf-3.2.5 → dynaconf-3.2.7}/dynaconf/base.py

@@ -229,7 +229,7 @@ class Settings:
         self._loaded_py_modules = []
         self._loaded_files = []
         self._deleted = set()
-        self._store = DynaBox(box_settings=self)
+        self._store = kwargs.pop("_store", DynaBox(box_settings=self))
         self._env_cache = {}
         self._loaded_by_loaders: dict[SourceMetadata | str, Any] = {}
         self._loaders = []
@@ -968,6 +968,15 @@ class Settings:
             self.store.get(key, None) if not isinstance(parsed, Lazy) else None
         )
 
+        if getattr(parsed, "_dynaconf_insert", False):
+            # `@insert` calls insert in a list by index
+            if existing and isinstance(existing, list):
+                source_metadata = source_metadata._replace(merged=True)
+                existing.insert(parsed.index, parsed.unwrap())
+                parsed = existing
+            else:
+                parsed = [parsed.unwrap()]
+
         if getattr(parsed, "_dynaconf_del", None):
             self.unset(key, force=True)  # `@del` in a first level var.
             return
@@ -1227,14 +1236,27 @@ class Settings:
             validate = self.get("VALIDATE_ON_UPDATE_FOR_DYNACONF")
 
         env = (env or self.current_env).upper()
+
         files = ensure_a_list(path)
         if files:
+            # Using inspect take the filename and line number of the caller
+            # to be used in the source_metadata
+            frame = inspect.currentframe()
+            caller = inspect.getouterframes(frame)[1]
             already_loaded = set()
             for _filename in files:
                 # load_file() will handle validation later
                 with suppress(ValidationError):
+                    source_metadata = SourceMetadata(
+                        loader=f"load_file@{caller.filename}:{caller.lineno}",
+                        identifier=_filename,
+                        env=env,
+                    )
                     if py_loader.try_to_load_from_py_module_name(
-                        obj=self, name=_filename, silent=True
+                        obj=self,
+                        name=_filename,
+                        silent=True,
+                        identifier=source_metadata,
                     ):
                         # if it was possible to load from module name
                         # continue the loop.
@@ -1265,6 +1287,11 @@ class Settings:
 
                     # load_file() will handle validation later
                     with suppress(ValidationError):
+                        source_metadata = SourceMetadata(
+                            loader=f"load_file@{caller.filename}:{caller.lineno}",
+                            identifier=path,
+                            env=env,
+                        )
                         settings_loader(
                             obj=self,
                             env=env,
@@ -1272,6 +1299,7 @@ class Settings:
                             key=key,
                             filename=path,
                             validate=validate,
+                            identifier=source_metadata,
                         )
                         already_loaded.add(path)
 
@@ -1357,7 +1385,7 @@ class Settings:
             value = self.get_fresh(key)
             return value is True or value in true_values
 
-    def populate_obj(self, obj, keys=None, ignore=None):
+    def populate_obj(self, obj, keys=None, ignore=None, internal=False):
         """Given the `obj` populate it using self.store items.
 
         :param obj: An object to be populated, a class instance.
@@ -1366,6 +1394,9 @@ class Settings:
         """
         keys = keys or self.keys()
         for key in keys:
+            if not internal:
+                if key in UPPER_DEFAULT_SETTINGS:
+                    continue
             key = upperfy(key)
             if ignore and key in ignore:
                 continue

{dynaconf-3.2.5 → dynaconf-3.2.7}/dynaconf/cli.py

@@ -1,22 +1,25 @@
 from __future__ import annotations
 
 import importlib
+import inspect as python_inspect
 import json
 import os
 import pprint
 import sys
 import warnings
 import webbrowser
+from contextlib import redirect_stdout
 from contextlib import suppress
 from pathlib import Path
-from typing import TYPE_CHECKING
 
 from dynaconf import constants
 from dynaconf import default_settings
 from dynaconf import LazySettings
 from dynaconf import loaders
 from dynaconf import settings as legacy_settings
+from dynaconf.base import Settings
 from dynaconf.loaders.py_loader import get_module
+from dynaconf.utils import prepare_json
 from dynaconf.utils import upperfy
 from dynaconf.utils.files import read_file
 from dynaconf.utils.functional import empty
@@ -33,9 +36,6 @@ from dynaconf.vendor import click
 from dynaconf.vendor import toml
 from dynaconf.vendor import tomllib
 
-if TYPE_CHECKING:  # pragma: no cover
-    from dynaconf.base import Settings  # noqa: F401
-
 os.environ["PYTHONIOENCODING"] = "utf-8"
 
 CWD = None
@@ -55,6 +55,8 @@ def set_settings(ctx, instance=None):
     settings = None
 
     _echo_enabled = ctx.invoked_subcommand not in ["get", "inspect", None]
+    if "--json" in click.get_os_args():
+        _echo_enabled = False
 
     if instance is not None:
         if ctx.invoked_subcommand in ["init"]:
@@ -79,19 +81,16 @@ def set_settings(ctx, instance=None):
                 )
     elif "DJANGO_SETTINGS_MODULE" in os.environ:  # pragma: no cover
         sys.path.insert(0, os.path.abspath(os.getcwd()))
-        try:
-            # Django extension v2
-            from django.conf import settings  # noqa
-            import dynaconf  # noqa: F401
-            import django
+        import django  # noqa
 
-            # see https://docs.djangoproject.com/en/4.2/ref/applications/
-            # at #troubleshooting
-            django.setup()
-
-            settings.DYNACONF.configure()
-        except AttributeError:
-            settings = LazySettings()
+        django.setup()  # ensure django is setup to avoid AppRegistryNotReady
+        settings_module = import__django_settings(
+            os.environ["DJANGO_SETTINGS_MODULE"]
+        )
+        for member in python_inspect.getmembers(settings_module):
+            if isinstance(member[1], (LazySettings, Settings)):
+                settings = member[1]
+                break
 
         if settings is not None and _echo_enabled:
             click.echo(
@@ -117,6 +116,18 @@ def set_settings(ctx, instance=None):
             settings = LazySettings()
 
 
+def import__django_settings(django_settings_module):
+    """Import the Django settings module from the string importable path."""
+    try:
+        with redirect_stdout(None):
+            module = importlib.import_module(django_settings_module)
+    except ImportError as e:
+        raise click.UsageError(e)
+    except FileNotFoundError:
+        return
+    return module
+
+
 def import_settings(dotted_path):
     """Import settings instance from python dotted path.
 
@@ -130,8 +141,10 @@ def import_settings(dotted_path):
         raise click.UsageError(
             f"invalid path to settings instance: {dotted_path}"
         )
+
     try:
-        module = importlib.import_module(module)
+        with redirect_stdout(None):
+            module = importlib.import_module(module)
     except ImportError as e:
         raise click.UsageError(e)
     except FileNotFoundError:
@@ -485,7 +498,7 @@ def get(key, default, env, unparse):
         result = unparse_conf_data(result)
 
     if isinstance(result, (dict, list, tuple)):
-        result = json.dumps(result, sort_keys=True)
+        result = json.dumps(prepare_json(result), sort_keys=True, default=repr)
 
     click.echo(result, nl=False)
 
@@ -530,7 +543,24 @@ def get(key, default, env, unparse):
     default=False,
     help="Output file is flat (do not include [env] name)",
 )
-def _list(env, key, more, loader, _all=False, output=None, flat=False):
+@click.option(
+    "--json",
+    "_json",
+    "-j",
+    is_flag=True,
+    default=False,
+    help="Prints out data serialized as JSON",
+)
+def _list(
+    env,
+    key,
+    more,
+    loader,
+    _all=False,
+    output=None,
+    flat=False,
+    _json=False,
+):
     """
     Lists user defined settings or all (including internal configs).
 
@@ -552,14 +582,15 @@ def _list(env, key, more, loader, _all=False, output=None, flat=False):
     if cur_env == "main":
         flat = True
 
-    click.echo(
-        click.style(
-            f"Working in {cur_env} environment ",
-            bold=True,
-            bg="bright_blue",
-            fg="bright_white",
+    if not _json:
+        click.echo(
+            click.style(
+                f"Working in {cur_env} environment ",
+                bold=True,
+                bg="bright_blue",
+                fg="bright_white",
+            )
         )
-    )
 
     if not loader:
         data = settings.as_dict(env=env, internal=_all)
@@ -585,14 +616,20 @@ def _list(env, key, more, loader, _all=False, output=None, flat=False):
         return f"{key}{data_type} {value}"
 
     if not key:
-        datalines = "\n".join(
-            format_setting(k, v)
-            for k, v in data.items()
-            if k not in data.get("RENAMED_VARS", [])
-        )
-        (click.echo_via_pager if more else click.echo)(datalines)
+        if not _json:
+            datalines = "\n".join(
+                format_setting(k, v)
+                for k, v in data.items()
+                if k not in data.get("RENAMED_VARS", [])
+            )
+            (click.echo_via_pager if more else click.echo)(datalines)
         if output:
-            loaders.write(output, data, env=not flat and cur_env)
+            loaders.write(output, prepare_json(data), env=not flat and cur_env)
+        if _json:
+            json_data = json.dumps(
+                prepare_json(data), sort_keys=True, default=repr
+            )
+            click.echo(json_data, nl=False)
     else:
         key = upperfy(key)
 
@@ -605,9 +642,16 @@ def _list(env, key, more, loader, _all=False, output=None, flat=False):
             click.secho("Key not found", bg="red", fg="white", err=True)
             return
 
-        click.echo(format_setting(key, value))
+        if not _json:
+            click.echo(format_setting(key, value))
         if output:
-            loaders.write(output, {key: value}, env=not flat and cur_env)
+            loaders.write(
+                output, prepare_json({key: value}), env=not flat and cur_env
+            )
+        if _json:
+            click.echo(
+                json.dumps(prepare_json({key: value}), default=repr), nl=True
+            )
 
     if env:
         settings.setenv()

{dynaconf-3.2.5 → dynaconf-3.2.7}/dynaconf/hooking.py

@@ -6,7 +6,6 @@ from functools import wraps
 from typing import Any
 from typing import Callable
 
-from dynaconf.base import RESERVED_ATTRS
 from dynaconf.base import Settings
 from dynaconf.loaders.base import SourceMetadata
 
@@ -77,17 +76,9 @@ def hookable(function=None, name=None):
         ):
             return fun(self, *args, **kwargs)
 
-        # Create an unhookable (to avoid recursion)
+        # Create an unhook-able (to avoid recursion)
         # temporary settings to pass to the hooked function
-        temp_settings = Settings(
-            dynaconf_skip_loaders=True,
-            dynaconf_skip_validators=True,
-        )
-        allowed_keys = self.__dict__.keys() - set(RESERVED_ATTRS)
-        temp_data = {
-            k: v for k, v in self.__dict__.items() if k in allowed_keys
-        }
-        temp_settings._store.update(temp_data)
+        temp_settings = TempSettingsHolder(self)
 
         def _hook(action: str, value: HookValue) -> HookValue:
             """executes the hooks for the given action"""
@@ -304,3 +295,49 @@ class HookableSettings(Settings):
     @hookable
     def get(self, *args, **kwargs):
         return Settings.get(self, *args, **kwargs)
+
+
+class TempSettingsHolder:
+    """Holds settings to be passed down to hooks.
+    To save runtime resources initialize a copy of it only if accessed.
+    """
+
+    _settings = None
+
+    def __init__(self, settings):
+        self._original_settings = settings
+
+    def _initialize(self):
+        if self._settings is None:
+            self._settings = Settings(
+                dynaconf_skip_loaders=True,
+                dynaconf_skip_validators=True,
+                _store=self._original_settings._store._safe_copy(),
+            )
+
+    def __getattr__(self, attr):
+        self._initialize()
+        return getattr(self._settings, attr)
+
+    def __getitem__(self, item):
+        self._initialize()
+        return self._settings[item]
+
+    def __setitem__(self, item, value):
+        self._initialize()
+        self._settings[item] = value
+
+    def __iter__(self):
+        self._initialize()
+        return iter(self._settings)
+
+    def __contains__(self, item):
+        self._initialize()
+        return item in self._settings
+
+    def __setattr__(self, attr, value):
+        if attr in ["_original_settings", "_settings"]:
+            super().__setattr__(attr, value)
+        else:
+            self._initialize()
+            setattr(self._settings, attr, value)

{dynaconf-3.2.5 → dynaconf-3.2.7}/dynaconf/loaders/__init__.py

@@ -12,6 +12,7 @@ from dynaconf.loaders import json_loader
 from dynaconf.loaders import py_loader
 from dynaconf.loaders import toml_loader
 from dynaconf.loaders import yaml_loader
+from dynaconf.loaders.base import SourceMetadata
 from dynaconf.utils import deduplicate
 from dynaconf.utils import ensure_a_list
 from dynaconf.utils.boxing import DynaBox
@@ -126,12 +127,13 @@ def execute_module_hooks(
         hook_file = os.path.join(
             os.path.dirname(loaded_file), "dynaconf_hooks.py"
         )
+        if not os.path.exists(hook_file):
+            # Return early if file doesn't exist.
+            # Faster than attempting to import.
+            continue
         hook_module = py_loader.import_from_filename(
             obj, hook_file, silent=silent
         )
-        if not hook_module:
-            # There was no hook on the same path as a python file
-            continue
         _run_hook_module(
             hook_type=hook,
             hook_module=hook_module,
@@ -221,6 +223,7 @@ def settings_loader(
     key=None,
     filename=None,
     validate=False,
+    identifier="settings_loader",
 ):
     """Loads from defined settings module
 
@@ -230,6 +233,8 @@ def settings_loader(
     :param silent: Boolean to raise loading errors
     :param key: Load a single key if provided
     :param filename: optional filename to override the settings_module
+    :param validate: If True validate the loaded data
+    :param identifier: A string or SourceMetadata to identify the loader
     """
     if filename is None:
         settings_module = settings_module or obj.settings_module
@@ -294,6 +299,9 @@ def settings_loader(
                 continue
 
             if mod_file.endswith(loader["ext"]):
+                if isinstance(identifier, str):
+                    # ensure it is always loader name
+                    identifier = loader["name"].lower()
                 loader["loader"].load(
                     obj,
                     filename=mod_file,
@@ -301,6 +309,7 @@ def settings_loader(
                     silent=silent,
                     key=key,
                     validate=validate,
+                    identifier=identifier,
                 )
                 continue
 
@@ -313,45 +322,73 @@ def settings_loader(
 
         # must be Python file or module
         # load from default defined module settings.py or .secrets.py if exists
-        py_loader.load(obj, mod_file, key=key, validate=validate)
+        py_loader.load(
+            obj, mod_file, key=key, validate=validate, identifier=identifier
+        )
 
         # load from the current env e.g: development_settings.py
+        # counting on the case where env is a comma separated string
         env = env or obj.current_env
-        if mod_file.endswith(".py"):
-            if ".secrets.py" == mod_file:
-                tmpl = ".{0}_{1}{2}"
-                mod_file = "secrets.py"
-            else:
-                tmpl = "{0}_{1}{2}"
-
-            dirname = os.path.dirname(mod_file)
-            filename, extension = os.path.splitext(os.path.basename(mod_file))
-            new_filename = tmpl.format(env.lower(), filename, extension)
-            env_mod_file = os.path.join(dirname, new_filename)
-            global_filename = tmpl.format("global", filename, extension)
-            global_mod_file = os.path.join(dirname, global_filename)
+        if env and isinstance(env, str):
+            for env_name in env.split(","):
+                load_from_env_named_file(
+                    obj, env_name, key, validate, identifier, mod_file
+                )
+
+
+def load_from_env_named_file(obj, env, key, validate, identifier, mod_file):
+    """Load from env named file e.g: development_settings.py"""
+    if mod_file.endswith(".py"):
+        if ".secrets.py" == mod_file:
+            tmpl = ".{0}_{1}{2}"
+            mod_file = "secrets.py"
         else:
-            env_mod_file = f"{env.lower()}_{mod_file}"
-            global_mod_file = f"global_{mod_file}"
+            tmpl = "{0}_{1}{2}"
+
+        dirname = os.path.dirname(mod_file)
+        filename, extension = os.path.splitext(os.path.basename(mod_file))
+        new_filename = tmpl.format(env.lower(), filename, extension)
+        env_mod_file = os.path.join(dirname, new_filename)
+        global_filename = tmpl.format("global", filename, extension)
+        global_mod_file = os.path.join(dirname, global_filename)
+    else:
+        parts = mod_file.rsplit(".", 1)
+        if len(parts) > 1:
+            head, tail = parts
+        else:
+            head, tail = None, parts[0]
+        tail = env_mod_file = f"{env.lower()}_{tail}"
 
-        py_loader.load(
-            obj,
-            env_mod_file,
-            identifier=f"py_{env.upper()}",
-            silent=True,
-            key=key,
-            validate=validate,
-        )
+        if head:
+            env_mod_file = f"{head}.{tail}"
+            global_mod_file = f"{head}.global_{tail}"
+        else:
+            env_mod_file = tail
+            global_mod_file = f"global_{tail}"
 
-        # load from global_settings.py
-        py_loader.load(
-            obj,
-            global_mod_file,
-            identifier="py_global",
-            silent=True,
-            key=key,
-            validate=validate,
-        )
+    source_metadata = SourceMetadata(
+        loader="py",
+        identifier=identifier,
+        env=env,
+    )
+    py_loader.load(
+        obj,
+        env_mod_file,
+        identifier=source_metadata,
+        silent=True,
+        key=key,
+        validate=validate,
+    )
+
+    # load from global_settings.py
+    py_loader.load(
+        obj,
+        global_mod_file,
+        identifier="py_global",
+        silent=True,
+        key=key,
+        validate=validate,
+    )
 
 
 def enable_external_loaders(obj):