"""
Main web server instance
"""
import functools
import argparse
import warnings
import inspect
import ssl
from typing import Union, Dict
from .patches.quart.app import Quart
import hashlib
from .patches.hypercorn import run, Config
from .caching import Cache
from .compression import Compression
[docs]def make_config_from_hypercorn_args(hypercorn_string: str, config: Config = Config()) -> Config:
""" Overrides a given config's items if they are specified in the hypercorn args string """
def _convert_verify_mode(value: str) -> ssl.VerifyMode:
try:
return ssl.VerifyMode[value]
except KeyError:
raise argparse.ArgumentTypeError("Not a valid verify mode")
sentinel = object()
parser = argparse.ArgumentParser()
parser.add_argument("--access-log", default=sentinel)
parser.add_argument("--access-logfile", default=sentinel)
parser.add_argument("--access-logformat", default=sentinel)
parser.add_argument("--backlog", type=int, default=sentinel)
parser.add_argument("-b", "--bind", dest="binds", default=[], action="append", )
parser.add_argument("--ca-certs", default=sentinel)
parser.add_argument("--certfile", default=sentinel)
parser.add_argument("--cert-reqs", type=int, default=sentinel)
parser.add_argument("--ciphers", default=sentinel)
parser.add_argument("-c", "--config", default=None)
parser.add_argument("--debug", action="store_true", default=sentinel)
parser.add_argument("--error-log", default=sentinel)
parser.add_argument("--error-logfile", "--log-file", dest="error_logfile", default=sentinel)
parser.add_argument("-g", "--group", default=sentinel, type=int)
parser.add_argument("-k", "--worker-class", dest="worker_class", default=sentinel)
parser.add_argument("--keep-alive", default=sentinel, type=int)
parser.add_argument("--keyfile", default=sentinel)
parser.add_argument("--insecure-bind", dest="insecure_binds", default=[], action="append")
parser.add_argument("--log-config", default=sentinel)
parser.add_argument("--log-level", default="info")
parser.add_argument("-p", "--pid", default=sentinel)
parser.add_argument("--quic-bind", dest="quic_binds", default=[], action="append")
parser.add_argument("--reload", action="store_true", default=sentinel)
parser.add_argument("--root-path", default=sentinel)
parser.add_argument("--statsd-host", default=sentinel)
parser.add_argument("--statsd-prefix", default="")
parser.add_argument("-m", "--umask", default=sentinel, type=int)
parser.add_argument("-u", "--user", default=sentinel, type=int)
parser.add_argument("-w", "--workers", dest="workers", default=sentinel, type=int)
parser.add_argument("--verify-mode", type=_convert_verify_mode, default=sentinel)
args = hypercorn_string.split(" ").remove("") if "" in hypercorn_string.split(" ") else hypercorn_string.split(" ")
args = parser.parse_args(args)
config.loglevel = args.log_level
if args.access_logformat is not sentinel:
config.access_log_format = args.access_logformat
if args.access_log is not sentinel:
warnings.warn("The --access-log argument is deprecated, use `--access-logfile` instead", DeprecationWarning, )
config.accesslog = args.access_log
if args.access_logfile is not sentinel:
config.accesslog = args.access_logfile
if args.backlog is not sentinel:
config.backlog = args.backlog
if args.ca_certs is not sentinel:
config.ca_certs = args.ca_certs
if args.certfile is not sentinel:
config.certfile = args.certfile
if args.cert_reqs is not sentinel:
config.cert_reqs = args.cert_reqs
if args.ciphers is not sentinel:
config.ciphers = args.ciphers
if args.debug is not sentinel:
config.debug = args.debug
if args.error_log is not sentinel:
warnings.warn("The --error-log argument is deprecated, use `--error-logfile` instead", DeprecationWarning, )
config.errorlog = args.error_log
if args.error_logfile is not sentinel:
config.errorlog = args.error_logfile
if args.group is not sentinel:
config.group = args.group
if args.keep_alive is not sentinel:
config.keep_alive_timeout = args.keep_alive
if args.keyfile is not sentinel:
config.keyfile = args.keyfile
if args.log_config is not sentinel:
config.logconfig = args.log_config
if args.pid is not sentinel:
config.pid_path = args.pid
if args.root_path is not sentinel:
config.root_path = args.root_path
if args.reload is not sentinel:
config.use_reloader = args.reload
if args.statsd_host is not sentinel:
config.statsd_host = args.statsd_host
if args.statsd_prefix is not sentinel:
config.statsd_prefix = args.statsd_prefix
if args.umask is not sentinel:
config.umask = args.umask
if args.user is not sentinel:
config.user = args.user
if args.worker_class is not sentinel:
config.worker_class = args.worker_class
if args.workers is not sentinel:
config.workers = args.workers
if len(args.binds) > 0:
config.bind = args.binds
if len(args.insecure_binds) > 0:
config.insecure_bind = args.insecure_binds
if len(args.quic_binds) > 0:
config.quic_bind = args.quic_binds
return config
[docs]class WebServer(Quart):
""" This is the main server class which extends a standard Flask class by a bunch of features and major
performance improvements. It extends the Quart class, which by itself is already an enhanced version of
the Flask class. This class however allows production-grade deployment using the hypercorn WSGI server
as production server. But instead of calling the hypercorn command via the console, it can be started
directly from the Python code itself, making it easier to integrate in higher-level scripts and
applications without calling os.system() od subprocess.Popen(). """
def __init__(self, import_name: str, host: str = "0.0.0.0", port: int = 80, include_server_header: bool = True,
hypercorn_arg_string: str = "", worker_threads: int = 1, logging_level: Union[int, str] = "INFO",
cache: Cache = Cache(), compression: Compression = Compression(level=2, min_size=10),
global_headers: Dict[str, str] = None,
*args, **kwargs):
super().__init__(import_name, *args, **kwargs)
self.logger.setLevel(logging_level)
self._host, self._port = host, port
self._global_headers = global_headers
self._hypercorn_arg_string = hypercorn_arg_string
self._worker_threads = worker_threads
self._include_server_header = include_server_header
self._cache = cache
self._compression = compression
[docs] def _get_own_instance_path(self):
"""
Retrieves the file and variable name of this instance to be used in the Hypercorn CLI.
Since hypercorn needs the application's file and global variable name, an instance needs to know
it's own origin file and name. But since this class is not defined in the same file as it is called
or defined from, this method searches for the correct module/file and evaluates it's instance name.
.. warning::
Deprecation warning: This method will be removed in future versions. Usage is highly discouraged.
"""
self.logger.warning("_get_own_instance_path() is deprecated!")
for i in range(10):
try:
frame = inspect.stack()[i][0].f_globals.items()
for key, val in frame:
try:
if val == self:
return f"{dict(frame)['__name__']}:{key}"
except (RuntimeError, AttributeError, KeyError):
pass
except:
pass
raise Exception("QuartServer() is unable to find own instance file:name")
[docs] def cache(self, timeout=None, key_prefix="view/%s", unless=None, forced_update=None,
response_filter=None, query_string=False, hash_method=hashlib.md5, cache_none=False, ):
""" A simple wrapper that forwards cached() decorator to the internal
Cache() instance. May be used as the normal @cache.cached() decorator. """
def decorator(f):
@functools.wraps(f)
@self._cache.cached(timeout=timeout, key_prefix=key_prefix, unless=unless, forced_update=forced_update,
response_filter=response_filter, query_string=query_string, hash_method=hash_method, cache_none=cache_none)
async def decorated_function(*args2, **kwargs2):
x = await f(*args2, **kwargs2)
return x
return decorated_function
return decorator
[docs] def run_server(self) -> None:
""" Generates the necessary config and runs the server instance. """
config = Config(self._global_headers)
config.bind = [f'{self._host}:{self._port}']
config.workers = self._worker_threads
config.include_server_header = self._include_server_header
# override config items if specified in hypercorn arguments
config = make_config_from_hypercorn_args(self._hypercorn_arg_string, config=config)
# Initialize extra features just in case the user replaced them with their own instances
self._cache.init_app(self)
if type(self._compression == Compression):
self._compression.init_app(self)
run(self, config)