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
|
"""
Command line interface (CLI)
============================
If you don't need to add :ref:`websockets <aiohttp-web-websockets>` or
:ref:`async request handlers <aiohttp-web-handler>` to your app, but still want to run your WSGI app on the
:mod:`asyncio` event loop, :mod:`aiohttp_wsgi` provides a simple command line interface.
Example usage
-------------
Serve a WSGI application called ``application``, located in the ``your_project.wsgi`` module:
.. code:: bash
aiohttp-wsgi-serve your_project.wsgi:application
Serve a WSGI application and include a static file directory.
.. code:: bash
aiohttp-wsgi-serve your_project.wsgi:application --static /static=./static
Command reference
-----------------
You can view this reference at any time with ``aiohttp-wsgi-serve --help``.
.. code:: bash
{help}
.. include:: /_include/links.rst
"""
import argparse
import logging
import os
import sys
from importlib import import_module
from typing import Any, Callable, Tuple
import aiohttp_wsgi
from aiohttp_wsgi.wsgi import serve, DEFAULTS, HELP
logger = logging.getLogger(__name__)
parser = argparse.ArgumentParser(
prog="aiohttp-wsgi-serve",
description="Run a WSGI application.",
)
def add_argument(name: str, *aliases: str, **kwargs: Any) -> None:
varname = name.strip("-").replace("-", "_")
# Format help.
kwargs.setdefault("help", HELP.get(varname, "").replace("``", ""))
assert kwargs["help"]
# Parse action.
kwargs.setdefault("action", "store")
if kwargs["action"] in ("append", "count"):
kwargs["help"] += " Can be specified multiple times."
if kwargs["action"] == "count":
kwargs.setdefault("default", 0)
if kwargs["action"] in ("append", "store"):
kwargs.setdefault("default", DEFAULTS.get(varname))
kwargs.setdefault("type", type(kwargs["default"]))
assert not isinstance(None, kwargs["type"])
parser.add_argument(name, *aliases, **kwargs)
add_argument(
"application",
metavar="module:application",
type=str,
)
add_argument(
"--host",
type=str,
action="append",
)
add_argument(
"--port",
"-p",
)
add_argument(
"--unix-socket",
type=str,
)
add_argument(
"--unix-socket-perms",
)
add_argument(
"--backlog",
)
add_argument(
"--static",
action="append",
default=[],
type=str,
help=(
"Static route mappings in the form 'path=directory'. "
"`path` must start with a slash, but not end with a slash."
),
)
add_argument(
"--static-cors",
type=str,
)
add_argument(
"--script-name",
)
add_argument(
"--url-scheme",
type=str,
)
add_argument(
"--threads",
)
add_argument(
"--inbuf-overflow",
)
add_argument(
"--max-request-body-size",
)
add_argument(
"--shutdown-timeout",
)
add_argument(
"--verbose",
"-v",
action="count",
help="Increase verbosity.",
)
add_argument(
"--quiet",
"-q",
action="count",
help="Decrease verbosity.",
)
add_argument(
"--version",
action="version",
help="Display version information.",
version=f"aiohttp-wsgi v{aiohttp_wsgi.__version__}",
)
def import_func(func: str) -> Callable:
assert ":" in func, f"{func!r} should have format 'module:callable'"
module_name, func_name = func.split(":", 1)
module = import_module(module_name)
func = getattr(module, func_name)
return func
def parse_static_item(static_item: str) -> Tuple[str, str]:
assert "=" in static_item, f"{static_item!r} should have format 'path=directory'"
return tuple(static_item.split("=", 1)) # type: ignore
def main() -> None:
sys.path.insert(0, os.getcwd())
# Parse the args.
kwargs = vars(parser.parse_args(sys.argv[1:]))
application = import_func(kwargs.pop("application"))
static = list(map(parse_static_item, kwargs.pop("static")))
# Set up logging.
verbosity = (kwargs.pop("verbose") - kwargs.pop("quiet")) * 10
logging.basicConfig(level=max(logging.ERROR - verbosity, logging.DEBUG), format="%(message)s")
logging.getLogger("aiohttp").setLevel(max(logging.INFO - verbosity, logging.DEBUG))
logger.setLevel(max(logging.INFO - verbosity, logging.DEBUG))
# Serve!
serve(application, static=static, **kwargs)
if __debug__:
import textwrap
__doc__ = __doc__.format(help=textwrap.indent(parser.format_help(), " "), **HELP)
|