335 lines
10 KiB
Python
335 lines
10 KiB
Python
from __future__ import annotations
|
|
|
|
from inspect import getmembers, isclass, isdatadescriptor
|
|
from os import environ
|
|
from pathlib import Path
|
|
from typing import Any, Callable, Dict, Optional, Sequence, Union
|
|
|
|
from sanic.errorpages import DEFAULT_FORMAT, check_error_format
|
|
from sanic.helpers import Default, _default
|
|
from sanic.http import Http
|
|
from sanic.log import deprecation, error_logger
|
|
from sanic.utils import load_module_from_file_location, str_to_bool
|
|
|
|
|
|
SANIC_PREFIX = "SANIC_"
|
|
|
|
|
|
DEFAULT_CONFIG = {
|
|
"_FALLBACK_ERROR_FORMAT": _default,
|
|
"ACCESS_LOG": True,
|
|
"AUTO_EXTEND": True,
|
|
"AUTO_RELOAD": False,
|
|
"EVENT_AUTOREGISTER": False,
|
|
"FORWARDED_FOR_HEADER": "X-Forwarded-For",
|
|
"FORWARDED_SECRET": None,
|
|
"GRACEFUL_SHUTDOWN_TIMEOUT": 15.0, # 15 sec
|
|
"KEEP_ALIVE_TIMEOUT": 5, # 5 seconds
|
|
"KEEP_ALIVE": True,
|
|
"MOTD": True,
|
|
"MOTD_DISPLAY": {},
|
|
"NOISY_EXCEPTIONS": False,
|
|
"PROXIES_COUNT": None,
|
|
"REAL_IP_HEADER": None,
|
|
"REGISTER": True,
|
|
"REQUEST_BUFFER_SIZE": 65536, # 64 KiB
|
|
"REQUEST_MAX_HEADER_SIZE": 8192, # 8 KiB, but cannot exceed 16384
|
|
"REQUEST_ID_HEADER": "X-Request-ID",
|
|
"REQUEST_MAX_SIZE": 100000000, # 100 megabytes
|
|
"REQUEST_TIMEOUT": 60, # 60 seconds
|
|
"RESPONSE_TIMEOUT": 60, # 60 seconds
|
|
"TOUCHUP": True,
|
|
"USE_UVLOOP": _default,
|
|
"WEBSOCKET_MAX_SIZE": 2**20, # 1 megabyte
|
|
"WEBSOCKET_PING_INTERVAL": 20,
|
|
"WEBSOCKET_PING_TIMEOUT": 20,
|
|
}
|
|
|
|
# These values will be removed from the Config object in v22.6 and moved
|
|
# to the application state
|
|
DEPRECATED_CONFIG = ("SERVER_RUNNING", "RELOADER_PROCESS", "RELOADED_FILES")
|
|
|
|
|
|
class DescriptorMeta(type):
|
|
def __init__(cls, *_):
|
|
cls.__setters__ = {name for name, _ in getmembers(cls, cls._is_setter)}
|
|
|
|
@staticmethod
|
|
def _is_setter(member: object):
|
|
return isdatadescriptor(member) and hasattr(member, "setter")
|
|
|
|
|
|
class Config(dict, metaclass=DescriptorMeta):
|
|
ACCESS_LOG: bool
|
|
AUTO_EXTEND: bool
|
|
AUTO_RELOAD: bool
|
|
EVENT_AUTOREGISTER: bool
|
|
FORWARDED_FOR_HEADER: str
|
|
FORWARDED_SECRET: Optional[str]
|
|
GRACEFUL_SHUTDOWN_TIMEOUT: float
|
|
KEEP_ALIVE_TIMEOUT: int
|
|
KEEP_ALIVE: bool
|
|
NOISY_EXCEPTIONS: bool
|
|
MOTD: bool
|
|
MOTD_DISPLAY: Dict[str, str]
|
|
PROXIES_COUNT: Optional[int]
|
|
REAL_IP_HEADER: Optional[str]
|
|
REGISTER: bool
|
|
REQUEST_BUFFER_SIZE: int
|
|
REQUEST_MAX_HEADER_SIZE: int
|
|
REQUEST_ID_HEADER: str
|
|
REQUEST_MAX_SIZE: int
|
|
REQUEST_TIMEOUT: int
|
|
RESPONSE_TIMEOUT: int
|
|
SERVER_NAME: str
|
|
TOUCHUP: bool
|
|
USE_UVLOOP: Union[Default, bool]
|
|
WEBSOCKET_MAX_SIZE: int
|
|
WEBSOCKET_PING_INTERVAL: int
|
|
WEBSOCKET_PING_TIMEOUT: int
|
|
|
|
def __init__(
|
|
self,
|
|
defaults: Dict[str, Union[str, bool, int, float, None]] = None,
|
|
env_prefix: Optional[str] = SANIC_PREFIX,
|
|
keep_alive: Optional[bool] = None,
|
|
*,
|
|
converters: Optional[Sequence[Callable[[str], Any]]] = None,
|
|
):
|
|
defaults = defaults or {}
|
|
super().__init__({**DEFAULT_CONFIG, **defaults})
|
|
|
|
self._converters = [str, str_to_bool, float, int]
|
|
self._LOGO = ""
|
|
|
|
if converters:
|
|
for converter in converters:
|
|
self.register_type(converter)
|
|
|
|
if keep_alive is not None:
|
|
self.KEEP_ALIVE = keep_alive
|
|
|
|
if env_prefix != SANIC_PREFIX:
|
|
if env_prefix:
|
|
self.load_environment_vars(env_prefix)
|
|
else:
|
|
self.load_environment_vars(SANIC_PREFIX)
|
|
|
|
self._configure_header_size()
|
|
self._check_error_format()
|
|
self._init = True
|
|
|
|
def __getattr__(self, attr):
|
|
try:
|
|
return self[attr]
|
|
except KeyError as ke:
|
|
raise AttributeError(f"Config has no '{ke.args[0]}'")
|
|
|
|
def __setattr__(self, attr, value) -> None:
|
|
self.update({attr: value})
|
|
|
|
def __setitem__(self, attr, value) -> None:
|
|
self.update({attr: value})
|
|
|
|
def update(self, *other, **kwargs) -> None:
|
|
kwargs.update({k: v for item in other for k, v in dict(item).items()})
|
|
setters: Dict[str, Any] = {
|
|
k: kwargs.pop(k)
|
|
for k in {**kwargs}.keys()
|
|
if k in self.__class__.__setters__
|
|
}
|
|
|
|
for key, value in setters.items():
|
|
try:
|
|
super().__setattr__(key, value)
|
|
except AttributeError:
|
|
...
|
|
|
|
super().update(**kwargs)
|
|
for attr, value in {**setters, **kwargs}.items():
|
|
self._post_set(attr, value)
|
|
|
|
def _post_set(self, attr, value) -> None:
|
|
if self.get("_init"):
|
|
if attr in (
|
|
"REQUEST_MAX_HEADER_SIZE",
|
|
"REQUEST_BUFFER_SIZE",
|
|
"REQUEST_MAX_SIZE",
|
|
):
|
|
self._configure_header_size()
|
|
elif attr == "LOGO":
|
|
self._LOGO = value
|
|
deprecation(
|
|
"Setting the config.LOGO is deprecated and will no longer "
|
|
"be supported starting in v22.6.",
|
|
22.6,
|
|
)
|
|
|
|
@property
|
|
def LOGO(self):
|
|
return self._LOGO
|
|
|
|
@property
|
|
def FALLBACK_ERROR_FORMAT(self) -> str:
|
|
if self._FALLBACK_ERROR_FORMAT is _default:
|
|
return DEFAULT_FORMAT
|
|
return self._FALLBACK_ERROR_FORMAT
|
|
|
|
@FALLBACK_ERROR_FORMAT.setter
|
|
def FALLBACK_ERROR_FORMAT(self, value):
|
|
self._check_error_format(value)
|
|
if (
|
|
self._FALLBACK_ERROR_FORMAT is not _default
|
|
and value != self._FALLBACK_ERROR_FORMAT
|
|
):
|
|
error_logger.warning(
|
|
"Setting config.FALLBACK_ERROR_FORMAT on an already "
|
|
"configured value may have unintended consequences."
|
|
)
|
|
self._FALLBACK_ERROR_FORMAT = value
|
|
|
|
def _configure_header_size(self):
|
|
Http.set_header_max_size(
|
|
self.REQUEST_MAX_HEADER_SIZE,
|
|
self.REQUEST_BUFFER_SIZE - 4096,
|
|
self.REQUEST_MAX_SIZE,
|
|
)
|
|
|
|
def _check_error_format(self, format: Optional[str] = None):
|
|
check_error_format(format or self.FALLBACK_ERROR_FORMAT)
|
|
|
|
def load_environment_vars(self, prefix=SANIC_PREFIX):
|
|
"""
|
|
Looks for prefixed environment variables and applies them to the
|
|
configuration if present. This is called automatically when Sanic
|
|
starts up to load environment variables into config.
|
|
|
|
It will automatically hydrate the following types:
|
|
|
|
- ``int``
|
|
- ``float``
|
|
- ``bool``
|
|
|
|
Anything else will be imported as a ``str``. If you would like to add
|
|
additional types to this list, you can use
|
|
:meth:`sanic.config.Config.register_type`. Just make sure that they
|
|
are registered before you instantiate your application.
|
|
|
|
.. code-block:: python
|
|
|
|
class Foo:
|
|
def __init__(self, name) -> None:
|
|
self.name = name
|
|
|
|
|
|
config = Config(converters=[Foo])
|
|
app = Sanic(__name__, config=config)
|
|
|
|
`See user guide re: config
|
|
<https://sanicframework.org/guide/deployment/configuration.html>`__
|
|
"""
|
|
lower_case_var_found = False
|
|
for key, value in environ.items():
|
|
if not key.startswith(prefix):
|
|
continue
|
|
if not key.isupper():
|
|
lower_case_var_found = True
|
|
|
|
_, config_key = key.split(prefix, 1)
|
|
|
|
for converter in reversed(self._converters):
|
|
try:
|
|
self[config_key] = converter(value)
|
|
break
|
|
except ValueError:
|
|
pass
|
|
if lower_case_var_found:
|
|
deprecation(
|
|
"Lowercase environment variables will not be "
|
|
"loaded into Sanic config beginning in v22.9.",
|
|
22.9,
|
|
)
|
|
|
|
def update_config(self, config: Union[bytes, str, dict, Any]):
|
|
"""
|
|
Update app.config.
|
|
|
|
.. note::
|
|
|
|
Only upper case settings are considered
|
|
|
|
You can upload app config by providing path to py file
|
|
holding settings.
|
|
|
|
.. code-block:: python
|
|
|
|
# /some/py/file
|
|
A = 1
|
|
B = 2
|
|
|
|
.. code-block:: python
|
|
|
|
config.update_config("${some}/py/file")
|
|
|
|
Yes you can put environment variable here, but they must be provided
|
|
in format: ``${some_env_var}``, and mark that ``$some_env_var`` is
|
|
treated as plain string.
|
|
|
|
You can upload app config by providing dict holding settings.
|
|
|
|
.. code-block:: python
|
|
|
|
d = {"A": 1, "B": 2}
|
|
config.update_config(d)
|
|
|
|
You can upload app config by providing any object holding settings,
|
|
but in such case config.__dict__ will be used as dict holding settings.
|
|
|
|
.. code-block:: python
|
|
|
|
class C:
|
|
A = 1
|
|
B = 2
|
|
|
|
config.update_config(C)
|
|
|
|
`See user guide re: config
|
|
<https://sanicframework.org/guide/deployment/configuration.html>`__
|
|
"""
|
|
|
|
if isinstance(config, (bytes, str, Path)):
|
|
config = load_module_from_file_location(location=config)
|
|
|
|
if not isinstance(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
|
|
|
|
def register_type(self, converter: Callable[[str], Any]) -> None:
|
|
"""
|
|
Allows for adding custom function to cast from a string value to any
|
|
other type. The function should raise ValueError if it is not the
|
|
correct type.
|
|
"""
|
|
if converter in self._converters:
|
|
error_logger.warning(
|
|
f"Configuration value converter '{converter.__name__}' has "
|
|
"already been registered"
|
|
)
|
|
return
|
|
self._converters.append(converter)
|