21.3deprecations

sanic/config.py

@@ -1,14 +1,8 @@
+from inspect import isclass
 from os import environ
+from pathlib import Path
 from typing import Any, Union
 
-# NOTE(tomaszdrozdz): remove in version: 21.3
-# We replace from_envvar(), from_object(), from_pyfile() config object methods
-# with one simpler update_config() method.
-# We also replace "loading module from file code" in from_pyfile()
-# in a favour of load_module_from_file_location().
-# Please see pull request: 1903
-# and issue: 1895
-from .deprecated import from_envvar, from_object, from_pyfile  # noqa
 from .utils import load_module_from_file_location, str_to_bool
 
 
@@ -68,17 +62,6 @@ def __getattr__(self, attr):
     def __setattr__(self, attr, value):
         self[attr] = value
 
-    # NOTE(tomaszdrozdz): remove in version: 21.3
-    # We replace from_envvar(), from_object(), from_pyfile() config object
-    # methods with one simpler update_config() method.
-    # We also replace "loading module from file code" in from_pyfile()
-    # in a favour of load_module_from_file_location().
-    # Please see pull request: 1903
-    # and issue: 1895
-    from_envvar = from_envvar
-    from_pyfile = from_pyfile
-    from_object = from_object
-
     def load_environment_vars(self, prefix=SANIC_PREFIX):
         """
         Looks for prefixed environment variables and applies
@@ -129,12 +112,24 @@ class C:
                 B = 2
             config.update_config(C)"""
 
-        if isinstance(config, (bytes, str)):
+        if isinstance(config, (bytes, str, Path)):
             config = load_module_from_file_location(location=config)
 
         if not isinstance(config, dict):
-            config = config.__dict__
+            cfg = {}
+            if not isclass(config):
+                cfg.update(
+                    {
+                        key: getattr(config, key)
+                        for key in config.__class__.__dict__.keys()
+                    }
+                )
+
+            config = dict(config.__dict__)
+            config.update(cfg)
 
         config = dict(filter(lambda i: i[0].isupper(), config.items()))
 
         self.update(config)
+
+    load = update_config

sanic/utils.py

@@ -1,9 +1,13 @@
+import types
+
 from importlib.util import module_from_spec, spec_from_file_location
 from os import environ as os_environ
+from pathlib import Path
 from re import findall as re_findall
 from typing import Union
 
-from .exceptions import LoadFileException
+from sanic.exceptions import LoadFileException, PyFileError
+from sanic.helpers import import_string
 
 
 def str_to_bool(val: str) -> bool:
@@ -39,7 +43,7 @@ def str_to_bool(val: str) -> bool:
 
 
 def load_module_from_file_location(
-    location: Union[bytes, str], encoding: str = "utf8", *args, **kwargs
+    location: Union[bytes, str, Path], encoding: str = "utf8", *args, **kwargs
 ):
     """Returns loaded module provided as a file path.
 
@@ -67,33 +71,60 @@ def load_module_from_file_location(
             "/some/path/${some_env_var}"
         )
     """
-
-    # 1) Parse location.
-    if isinstance(location, bytes):
-        location = location.decode(encoding)
-
-    # A) Check if location contains any environment variables
-    #    in format ${some_env_var}.
-    env_vars_in_location = set(re_findall(r"\${(.+?)}", location))
-
-    # B) Check these variables exists in environment.
-    not_defined_env_vars = env_vars_in_location.difference(os_environ.keys())
-    if not_defined_env_vars:
-        raise LoadFileException(
-            "The following environment variables are not set: "
-            f"{', '.join(not_defined_env_vars)}"
-        )
-
-    # C) Substitute them in location.
-    for env_var in env_vars_in_location:
-        location = location.replace("${" + env_var + "}", os_environ[env_var])
-
-    # 2) Load and return module.
-    name = location.split("/")[-1].split(".")[
-        0
-    ]  # get just the file name without path and .py extension
-    _mod_spec = spec_from_file_location(name, location, *args, **kwargs)
-    module = module_from_spec(_mod_spec)
-    _mod_spec.loader.exec_module(module)  # type: ignore
-
-    return module
+    if isinstance(location, Path) or "/" in location or "$" in location:
+        if isinstance(location, bytes):
+            location = location.decode(encoding)
+
+        if not isinstance(location, Path):
+            # A) Check if location contains any environment variables
+            #    in format ${some_env_var}.
+            env_vars_in_location = set(re_findall(r"\${(.+?)}", location))
+
+            # B) Check these variables exists in environment.
+            not_defined_env_vars = env_vars_in_location.difference(
+                os_environ.keys()
+            )
+            if not_defined_env_vars:
+                raise LoadFileException(
+                    "The following environment variables are not set: "
+                    f"{', '.join(not_defined_env_vars)}"
+                )
+
+            # C) Substitute them in location.
+            for env_var in env_vars_in_location:
+                location = location.replace(
+                    "${" + env_var + "}", os_environ[env_var]
+                )
+
+        location = str(location)
+        if ".py" in location:
+            name = location.split("/")[-1].split(".")[
+                0
+            ]  # get just the file name without path and .py extension
+            _mod_spec = spec_from_file_location(
+                name, location, *args, **kwargs
+            )
+            module = module_from_spec(_mod_spec)
+            _mod_spec.loader.exec_module(module)  # type: ignore
+
+        else:
+            module = types.ModuleType("config")
+            module.__file__ = str(location)
+            try:
+                with open(location) as config_file:
+                    exec(  # nosec
+                        compile(config_file.read(), location, "exec"),
+                        module.__dict__,
+                    )
+            except IOError as e:
+                e.strerror = "Unable to load configuration file (e.strerror)"
+                raise
+            except Exception as e:
+                raise PyFileError(location) from e
+
+        return module
+    else:
+        try:
+            return import_string(location)
+        except ValueError:
+            raise IOError("Unable to load configuration %s" % str(location))