A modern Python WSGI server.
Project description
Zī Bái
中曲之山有兽焉,其状如马而白身黑尾,一角,虎牙爪,音如鼓音,其名曰駮,是食虎豹,可以御兵。
A modern Python WSGI server. Can be launched using the command line or programmatically.
Correct handling of the HTTP protocol is ensured by h11. Optional gevent.
- Cross-platform multi-process management. (You no longer have to worry about gunicorn not being available on Windows😀)
- Support IPv4, IPv6, Unix socket.
- Graceful restart. If code or configuration is updated, new workers will use them.
- Server event hooks. (If you want to do something extra at specific times 🙂)
- Clean and pure way of programming. Can be used any way you want.
Inspiration from Uvicorn, GUnicorn, Waitress, runweb.
Quick start
python -m pip install zibai-server[gevent,reload]
# Then run your WSGI application like kui, django, flask, etc.
python -m zibai example:app
Multiple processes:
python -m zibai example:app -p 4
Auto reload in development:
python -m zibai example:app --watchfiles "*.py;.env"
Use --help
to see all available options.
python -m zibai --help
usage: __main__.py [-h] [--listen LISTEN] [--backlog BACKLOG] [--dualstack-ipv6] [--unix-socket-perms UNIX_SOCKET_PERMS] [--subprocess SUBPROCESS] [--watchfiles WATCHFILES]
[--max-workers MAX_WORKERS] [--h11-max-incomplete-event-size H11_MAX_INCOMPLETE_EVENT_SIZE] [--max-request-pre-process MAX_REQUEST_PRE_PROCESS]
[--before-serve BEFORE_SERVE] [--before-graceful-exit BEFORE_GRACEFUL_EXIT] [--before-died BEFORE_DIED]
app
positional arguments:
app WSGI app
options:
-h, --help show this help message and exit
--listen LISTEN, -l LISTEN
listen address, HOST:PORT, unix:PATH (default: 127.0.0.1:9000)
--backlog BACKLOG listen backlog (default: None)
--dualstack-ipv6 enable dualstack ipv6 (default: False)
--unix-socket-perms UNIX_SOCKET_PERMS
unix socket permissions (default: 600)
--subprocess SUBPROCESS, -p SUBPROCESS
number of subprocesses (default: 0)
--watchfiles WATCHFILES
watch files for changes and restart workers (default: None)
--max-workers MAX_WORKERS, -w MAX_WORKERS
maximum number of threads or greenlets to use for handling requests (default: 1000)
--h11-max-incomplete-event-size H11_MAX_INCOMPLETE_EVENT_SIZE
maximum number of bytes in an incomplete HTTP event (default: None)
--max-request-pre-process MAX_REQUEST_PRE_PROCESS
maximum number of requests to process before killing the worker (default: None)
--before-serve BEFORE_SERVE
callback to run before serving requests (default: None)
--before-graceful-exit BEFORE_GRACEFUL_EXIT
callback to run before graceful exit (default: None)
--before-died BEFORE_DIED
callback to run before exiting (default: None)
Use programmatically
import logging
logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")
def app(environ, start_response):
status = "200 OK"
headers = [("Content-type", "text/plain; charset=utf-8"), ("Content-Length", "12")]
start_response(status, headers)
return [b"Hello World!"]
if __name__ == "__main__":
import sys
from zibai.cli import parse_args, main
options = parse_args(["example:app"] + sys.argv[1:])
main(options)
Options
consists of easily serializable types such as string, number, or None. Apart from necessary checks, there is no behavior similar to bind socket or create object. So if you don't want to read and parse the configuration from the command line, you can also create Options
yourself.
from zibai.cli import Options, main
options = Options(app="example:app")
main(options)
Maybe you like to get the app in factory mode, just do this:
import sys
import zibai.cli
zibai.cli.get_app = lambda string: zibai.cli.import_from_string(string)()
options = zibai.cli.parse_args(sys.argv[1:])
zibai.cli.main(options)
Advanced usage
If Options
cannot meet your customization needs, you can use the serve
function directly.
def app(environ, start_response):
status = "200 OK"
headers = [("Content-type", "text/plain; charset=utf-8"), ("Content-Length", "12")]
start_response(status, headers)
return [b"Hello World!"]
if __name__ == "__main__":
import threading
import zibai
exit_event = threading.Event()
zibai.serve(
app=app,
bind_socket=your_socket,
backlog=None,
max_workers=10,
graceful_exit=exit_event,
before_serve_hook=your_hook,
before_graceful_exit_hook=your_hook,
before_died_hook=your_hook,
)
Event hooks
The following hooks will be executed in each worker process:
before_serve
is called before serving requests.before_graceful_exit
is called before graceful exit.before_died
is called before exiting.
Logging
Zī Bái uses the standard Python logging module. You can configure it as you like.
# Process management, service startup or termination logs.
logger = logging.getLogger("zibai")
# Used for DEBUG http protocol errors, generally do not enable it.
debug_logger = logging.getLogger("zibai.debug")
# Access logs. Non-5xx type request logs will use this.
access_logger = logging.getLogger("zibai.access")
# Error logs. 5xx type request logs will use this.
error_logger = logging.getLogger("zibai.error")
You can configure the output format of access_logger
and error_logger
to access values in WSGI Environ.
from zibai.logger import access_logger
handler = logging.StreamHandler()
handler.formatter = logging.Formatter(
"%(asctime)s [%(REMOTE_ADDR)s] %(levelname)s %(message)s", "%Y-%m-%d %H:%M:%S"
)
access_logger.addHandler(handler)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for zibai_server-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f85e32278140aa3cf886ac1a2ec3a0965d174666b52a282a016cd4593e0e249d |
|
MD5 | b6837e2b70384cdb39eccaf0b01f852f |
|
BLAKE2b-256 | 6232c732af3a42b536281f95400ffa0b863429d01a8d06e05a743530a4d034b8 |