105 |
106 |
107 | {% if site.google_analytics %}
108 | {% include google_analytics.html %}
109 | {% endif %}
110 |
111 |
--------------------------------------------------------------------------------
/docs/_includes/head.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | {{ page.title }} | {{ site.site_title }}
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 | {% if site.use_math %}
25 |
26 |
27 |
28 |
39 | {% endif %}
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
56 |
57 |
58 |
59 |
60 | {% if site.twitter_username %}
61 |
62 |
63 |
64 | {% endif %}
65 |
66 | {% if page.summary %}
67 |
68 | {% else %}
69 |
70 | {% endif %}
71 |
72 | {% if page.image %}
73 |
74 |
75 | {% else %}
76 |
77 |
78 | {% endif %}
79 |
80 |
81 |
82 |
83 |
84 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # fastcgi
2 | > FastCGI and HTTP handlers for Python's `socketserver` classes
3 |
4 |
5 | [FastCGI](http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html) is a way for front-end servers to talk to back-end workers in a (somewhat) efficient and (somewhat) simple way. Although it's been around since 1996, it is not very widely appreciated, except in the PHP community, where it is very commonly used.
6 |
7 | It can be a great approach for hosting Python scripts, avoiding the overhead of creating a new Python process for every request (as standard CGI would otherwise require) and without requiring large dependencies, complex C projects, or fiddly deployments. `fastcgi` has no dependencies other than [fastcore](https://fastcore.fast.ai/).
8 |
9 | There's no new frameworks or concepts to learn. Just call `send` to send anything you like back to the client, read the parameters from `params`, and the input from the client from `stdin`.
10 |
11 | `fastcgi` requires a front-end web server. If you don't already have one set up, we recommend [Caddy](https://caddyserver.com/). To forward all requests to `example.com` to a `fastcgi` server listening on port 1234 create a file called `Caddyfile` with the following contents, and then `caddy run`:
12 |
13 | example.com
14 | reverse_proxy localhost:1234 { transport fastcgi }
15 |
16 | This library also provides an HTTP handler that can be used in an identical way, except remove `{ transport fastcgi }` from the above `Caddyfile` example. Python's standard library already includes an HTTP handler (in `http.server`), however the documentation warns that that module should not be used in production code. The HTTP handler provided here is trimmed down to a minimal implementation (just 40 lines of code) so that it can easily be studied and extended. It uses the same basic API as Python's other `socketserver` classes (and the same as `FcgiHandler` here) so there's fewer new concepts to understand.
17 |
18 | ## Install
19 |
20 | `pip install fastcgi` or `conda install -c fastai fastcgi`
21 |
22 | ## How to use
23 |
24 | See the full docs pages for each class for details. Quick overviews of each approach are shown below.
25 |
26 | ### fastcgi decorator
27 |
28 | Using the `fastcgi` decorator you can use CGI scripts with minimal changes. Just add the decorator above a function used for CGI, and it converts that script automatically into a FastCGI server, e.g if you save this as `server.py`:
29 |
30 | ```python
31 | @fastcgi()
32 | def hello():
33 | query = os.environ["QUERY_STRING"]
34 | content = sys.stdin.read()
35 | sys.stdout.write(f"Content-type: text/html\r\n\r\n{content} ; ")
36 | sys.stdout.write(f"{query}\r\n")
37 | ```
38 |
39 | ...then if you run `python server.py` it will make a unix socket available as `fcgi.sock` in the current directory.
40 |
41 | ### FcgiHandler
42 |
43 | `FcgiHandler` is used in much the same way as Python's [BaseRequestHandler](https://docs.python.org/3/library/socketserver.html#request-handler-objects). Here's an example:
44 |
45 | ```python
46 | class TestHandler(FcgiHandler):
47 | def handle(self):
48 | print('query:', self.environ['QUERY_STRING'])
49 | print('content type:', self.environ['HTTP_CONTENT_TYPE'])
50 | print('stdin:', self['stdin'].read())
51 | self['stdout'].write(b"Content-type: text/html\r\n\r\nfoobar\r\n")
52 | ```
53 |
54 | You can run this using any of Python's `socketserver` classes, e.g to listen on localhost port 1234:
55 |
56 | ```python
57 | with TCPServer(('localhost',1234), TestHandler) as srv:
58 | srv.handle_request()
59 | ```
60 |
61 | See the API docs for `FcgiHandler` for an end-to-end example.
62 |
63 | You can also create a forking or threading server by using Python's [mixins or predefined classes](https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingMixIn).
64 |
65 | In your `handle` method, you can use the `stdin`, `stdout`, and `stderr` attributes, which each contain a `BytesIO` stream.
66 |
67 | ### MinimalHTTPHandler
68 |
69 | `fastcgi` also comes with the `MinimalHTTPHandler` class, which provides very similar functionality to `FcgiHandler`, but using the `HTTP` protocol instead of the `FastCGI` protocol. Here's an example:
70 |
71 | ```python
72 | class _TestHandler(MinimalHTTPHandler):
73 | def handle(self):
74 | print(f'Command/path/version: {self.command} {self.path} {self.request_version}')
75 | print(self.headers)
76 | self.send_response(200)
77 | self.send_header("Content-Type", "text/plain")
78 | self.send_header('Content-Length', '2')
79 | self.end_headers()
80 | self.wfile.write(b'ok')
81 | ```
82 |
83 | You can run it with a `socketserver` server in the same way shown above for `FcgiHandler`.
84 |
--------------------------------------------------------------------------------
/fastcgi/core.py:
--------------------------------------------------------------------------------
1 | # AUTOGENERATED! DO NOT EDIT! File to edit: 00_core.ipynb (unless otherwise specified).
2 |
3 | __all__ = ['Record', 'Role', 'Status', 'readlen', 'recv_record', 'params', 'send_record', 'send_stream', 'FcgiHandler',
4 | 'TextWrapper']
5 |
6 | # Cell
7 | from fastcore.foundation import *
8 | from fastcore.utils import *
9 | from fastcore.meta import *
10 |
11 | import struct
12 | from socketserver import StreamRequestHandler,BaseRequestHandler,UnixStreamServer,TCPServer
13 | from enum import Enum
14 | from io import BytesIO,TextIOWrapper,StringIO
15 |
16 | # Cell
17 | Record = Enum('Record', 'BEGIN_REQUEST ABORT_REQUEST END_REQUEST PARAMS STDIN '
18 | 'STDOUT STDERR DATA GET_VALUES GET_VALUES_RESULT')
19 | Role = Enum('Role', 'RESPONDER AUTHORIZER FILTER')
20 | Status = Enum('Status', 'REQUEST_COMPLETE CANT_MPX_CONN OVERLOADED UNKNOWN_ROLE')
21 |
22 | # Cell
23 | def _S(fmt): return struct.Struct('!'+fmt) # use `struct` "network order"
24 | _rec_struct,_endreq_struct,_begreq_struct,_long_struct = _S('BBHHbb'),_S('LBxxx'),_S('Hb5s'),_S('L')
25 | _streams_data = Record.STDIN,Record.DATA
26 | _streams_in = (Record.PARAMS,) + _streams_data
27 | _streams_out = Record.STDOUT,Record.STDERR
28 | _streams = _streams_in + _streams_out + (Record.END_REQUEST,)
29 |
30 | # Cell
31 | def readlen(r):
32 | "Read the length of the next fcgi parameter"
33 | # See http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html#S3.4
34 | a = r(1)
35 | res = a[0]
36 | if res>>7: res =_long_struct.unpack(a+r(3))[0] & 0x7fffffff
37 | return res
38 |
39 | # Cell
40 | def _recv_struct(recv, fmt):
41 | if not isinstance(fmt,struct.Struct): fmt = _S(fmt)
42 | res = fmt.unpack(recv(fmt.size))
43 | return res[0] if len(res)==1 else res
44 |
45 | # Cell
46 | def recv_record(r):
47 | "Receive one fastcgi record from `r`"
48 | _,typ,_,contentlen,padlen,_ = _recv_struct(r, _rec_struct)
49 | c = _recv_struct(r, f'{contentlen}s{"x"*padlen}')
50 | typ = Record(typ)
51 | if typ==Record.BEGIN_REQUEST: c = _begreq_struct.unpack(c)[:2]
52 | elif typ==Record.ABORT_REQUEST: c = ()
53 | return typ,c
54 |
55 | # Cell
56 | def _params(s):
57 | b = BytesIO(s)
58 | r = b.read
59 | while b.tell()dict:
64 | "Parse fastcgi parameters from `s`"
65 | return {k.decode():v.decode() for k,v in _params(s)}
66 |
67 | # Cell
68 | def send_record(typ, w, c=b''):
69 | "Send fastcgi binary record of `typ` to `w`"
70 | for o in chunked(c, 64000): w(_rec_struct.pack(1, typ.value, 1, len(o), 0, 0) + bytes(o))
71 |
72 | # Cell
73 | def send_stream(typ, w, s):
74 | "Send fastcgi stream of `typ` to `w`"
75 | v = s.getvalue()
76 | if not v: return
77 | send_record(typ, w, v)
78 | send_record(typ, w)
79 |
80 | # Cell
81 | class FcgiHandler(StreamRequestHandler):
82 | "A request handler that processes FastCGI streams and parameters"
83 | rbufsize = wbufsize = 2**16
84 | def setup(self):
85 | super().setup()
86 | self.streams = {o:BytesIO() for o in _streams}
87 | sz,self.length = 0,1
88 | while szstr:
130 | "Contents of stdin"
131 | return self['stdin'].getvalue().decode()
132 |
133 | # Cell
134 | @patch
135 | def write(self:FcgiHandler, b:bytes, err=False):
136 | "Write `b` to stderr (if `err`) or stdout (otherwise)"
137 | self['stderr' if err else 'stdout'].write(b)
--------------------------------------------------------------------------------
/docs/js/jekyll-search.js:
--------------------------------------------------------------------------------
1 | !function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a="function"==typeof require&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}for(var i="function"==typeof require&&require,o=0;o=0}var self=this;self.matches=function(string,crit){return"string"!=typeof string?!1:(string=string.trim(),doMatch(string,crit))}}module.exports=new LiteralSearchStrategy},{}],4:[function(require,module){module.exports=function(){function findMatches(store,crit,strategy){for(var data=store.get(),i=0;i{title}
',noResultsText:"No results found",limit:10,fuzzy:!1};self.init=function(_opt){validateOptions(_opt),assignOptions(_opt),isJSON(opt.dataSource)?initWithJSON(opt.dataSource):initWithURL(opt.dataSource)}}var Searcher=require("./Searcher"),Templater=require("./Templater"),Store=require("./Store"),JSONLoader=require("./JSONLoader"),searcher=new Searcher,templater=new Templater,store=new Store,jsonLoader=new JSONLoader;window.SimpleJekyllSearch=new SimpleJekyllSearch}(window,document)},{"./JSONLoader":1,"./Searcher":4,"./Store":5,"./Templater":6}]},{},[7]);
2 |
--------------------------------------------------------------------------------
/01_decorator.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "code",
5 | "execution_count": null,
6 | "metadata": {},
7 | "outputs": [],
8 | "source": [
9 | "#default_exp decorator"
10 | ]
11 | },
12 | {
13 | "cell_type": "markdown",
14 | "metadata": {},
15 | "source": [
16 | "# fastcgi.decorator\n",
17 | "> Instant fastcgi scripts by just adding a decorator"
18 | ]
19 | },
20 | {
21 | "cell_type": "code",
22 | "execution_count": null,
23 | "metadata": {},
24 | "outputs": [],
25 | "source": [
26 | "#export\n",
27 | "from fastcgi.core import FcgiHandler,TextWrapper\n",
28 | "from fastcore.basics import *\n",
29 | "from fastcore.imports import *\n",
30 | "from socketserver import UnixStreamServer,TCPServer,ForkingMixIn,ForkingTCPServer\n",
31 | "import inspect,os,sys"
32 | ]
33 | },
34 | {
35 | "cell_type": "code",
36 | "execution_count": null,
37 | "metadata": {},
38 | "outputs": [],
39 | "source": [
40 | "#export\n",
41 | "_all_ = ['os','sys']"
42 | ]
43 | },
44 | {
45 | "cell_type": "code",
46 | "execution_count": null,
47 | "metadata": {},
48 | "outputs": [],
49 | "source": [
50 | "from fastcore.utils import *\n",
51 | "from fastcore.script import *\n",
52 | "import subprocess,time,urllib"
53 | ]
54 | },
55 | {
56 | "cell_type": "code",
57 | "execution_count": null,
58 | "metadata": {},
59 | "outputs": [],
60 | "source": [
61 | "#export\n",
62 | "class ForkingUnixServer(ForkingMixIn, UnixStreamServer): pass"
63 | ]
64 | },
65 | {
66 | "cell_type": "code",
67 | "execution_count": null,
68 | "metadata": {},
69 | "outputs": [],
70 | "source": [
71 | "#export\n",
72 | "def fastcgi(sock='fcgi.sock', func=None):\n",
73 | " if callable(sock): sock,func = 'fcgi.sock',sock\n",
74 | " if isinstance(sock,Path): sock = str(sock)\n",
75 | " if func is None: return partial(fastcgi, sock)\n",
76 | "\n",
77 | " mod = inspect.getmodule(inspect.currentframe().f_back)\n",
78 | " class DecorateHandler(FcgiHandler):\n",
79 | " def handle(self):\n",
80 | " oldin,oldout,oldenv = sys.stdin,sys.stdout,os.environ\n",
81 | " try:\n",
82 | " sys.stdin,sys.stdout,os.environ = TextWrapper(self['stdin']),TextWrapper(self['stdout']),self.environ\n",
83 | " func()\n",
84 | " finally: sys.stdin,sys.stdout,os.environ = oldin,oldout,oldenv\n",
85 | "\n",
86 | " srv_type = ForkingUnixServer if isinstance(sock,str) else ForkingTCPServer\n",
87 | " f = partial(srv_type, sock, DecorateHandler)\n",
88 | " if mod and mod.__name__==\"__main__\":\n",
89 | " if isinstance(sock,str) and os.path.exists(sock): os.unlink(sock)\n",
90 | " try:\n",
91 | " with f() as srv: srv.serve_forever()\n",
92 | " except KeyboardInterrupt:\n",
93 | " if isinstance(sock,str):os.unlink(sock)\n",
94 | " else: return f"
95 | ]
96 | },
97 | {
98 | "cell_type": "code",
99 | "execution_count": null,
100 | "metadata": {},
101 | "outputs": [],
102 | "source": [
103 | "def c():\n",
104 | " return \"Content-type: text/html\\r\\n\\r\\n\" \\\n",
105 | " + f'{sys.stdin.read()} ; {os.environ[\"QUERY_STRING\"]}\\r\\n'"
106 | ]
107 | },
108 | {
109 | "cell_type": "code",
110 | "execution_count": null,
111 | "metadata": {},
112 | "outputs": [],
113 | "source": [
114 | "p = Path('fcgi.sock')\n",
115 | "\n",
116 | "@fastcgi(p)\n",
117 | "def hello(): sys.stdout.write(c())\n",
118 | "\n",
119 | "@threaded\n",
120 | "def _f():\n",
121 | " with hello() as srv: srv.handle_request()"
122 | ]
123 | },
124 | {
125 | "cell_type": "code",
126 | "execution_count": null,
127 | "metadata": {},
128 | "outputs": [
129 | {
130 | "name": "stdout",
131 | "output_type": "stream",
132 | "text": [
133 | "foo=bar&greeting=你好 ; a=1\r\n",
134 | "\n"
135 | ]
136 | }
137 | ],
138 | "source": [
139 | "proc = subprocess.Popen(['./http2fcgi'])\n",
140 | "if p.exists(): p.unlink()\n",
141 | "t = _f()\n",
142 | "time.sleep(0.2)\n",
143 | "res = urlread('http://localhost:6065/setup.py?a=1', foo='bar', greeting='你好')\n",
144 | "print(urllib.parse.unquote(res.decode()))\n",
145 | "proc.terminate()"
146 | ]
147 | },
148 | {
149 | "cell_type": "code",
150 | "execution_count": null,
151 | "metadata": {},
152 | "outputs": [],
153 | "source": [
154 | "addr = 'localhost',8003\n",
155 | "\n",
156 | "@fastcgi(addr)\n",
157 | "def hello(): sys.stdout.write(c())"
158 | ]
159 | },
160 | {
161 | "cell_type": "code",
162 | "execution_count": null,
163 | "metadata": {},
164 | "outputs": [
165 | {
166 | "name": "stdout",
167 | "output_type": "stream",
168 | "text": [
169 | "foo=bar&greeting=你好 ; a=1\r\n",
170 | "\n"
171 | ]
172 | }
173 | ],
174 | "source": [
175 | "time.sleep(0.5)\n",
176 | "proc = subprocess.Popen('./http2fcgi -fcgi tcp://localhost:8003'.split())\n",
177 | "t = _f()\n",
178 | "time.sleep(0.2)\n",
179 | "res = urlread('http://localhost:6065/setup.py?a=1', foo='bar', greeting='你好')\n",
180 | "print(urllib.parse.unquote(res.decode()))\n",
181 | "proc.terminate()"
182 | ]
183 | },
184 | {
185 | "cell_type": "markdown",
186 | "metadata": {},
187 | "source": [
188 | "## fin -"
189 | ]
190 | },
191 | {
192 | "cell_type": "code",
193 | "execution_count": null,
194 | "metadata": {},
195 | "outputs": [
196 | {
197 | "name": "stdout",
198 | "output_type": "stream",
199 | "text": [
200 | "Converted 00_core.ipynb.\n",
201 | "Converted 01_decorator.ipynb.\n",
202 | "Converted 02_http.ipynb.\n",
203 | "Converted index.ipynb.\n"
204 | ]
205 | }
206 | ],
207 | "source": [
208 | "#hide\n",
209 | "from nbdev.export import notebook2script\n",
210 | "notebook2script()"
211 | ]
212 | },
213 | {
214 | "cell_type": "code",
215 | "execution_count": null,
216 | "metadata": {},
217 | "outputs": [],
218 | "source": []
219 | }
220 | ],
221 | "metadata": {
222 | "kernelspec": {
223 | "display_name": "Python 3",
224 | "language": "python",
225 | "name": "python3"
226 | }
227 | },
228 | "nbformat": 4,
229 | "nbformat_minor": 4
230 | }
231 |
--------------------------------------------------------------------------------
/index.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "code",
5 | "execution_count": null,
6 | "metadata": {},
7 | "outputs": [],
8 | "source": [
9 | "#hide\n",
10 | "from fastcgi import *"
11 | ]
12 | },
13 | {
14 | "cell_type": "markdown",
15 | "metadata": {},
16 | "source": [
17 | "# fastcgi\n",
18 | "\n",
19 | "> FastCGI and HTTP handlers for Python's `socketserver` classes"
20 | ]
21 | },
22 | {
23 | "cell_type": "markdown",
24 | "metadata": {},
25 | "source": [
26 | "[FastCGI](http://www.mit.edu/~yandros/doc/specs/fcgi-spec.html) is a way for front-end servers to talk to back-end workers in a (somewhat) efficient and (somewhat) simple way. Although it's been around since 1996, it is not very widely appreciated, except in the PHP community, where it is very commonly used.\n",
27 | "\n",
28 | "It can be a great approach for hosting Python scripts, avoiding the overhead of creating a new Python process for every request (as standard CGI would otherwise require) and without requiring large dependencies, complex C projects, or fiddly deployments. `fastcgi` has no dependencies other than [fastcore](https://fastcore.fast.ai/).\n",
29 | "\n",
30 | "There's no new frameworks or concepts to learn. Just call `send` to send anything you like back to the client, read the parameters from `params`, and the input from the client from `stdin`.\n",
31 | "\n",
32 | "`fastcgi` requires a front-end web server. If you don't already have one set up, we recommend [Caddy](https://caddyserver.com/). To forward all requests to `example.com` to a `fastcgi` server listening on port 1234 create a file called `Caddyfile` with the following contents, and then `caddy run`:\n",
33 | "\n",
34 | " example.com\n",
35 | " reverse_proxy localhost:1234 { transport fastcgi }\n",
36 | "\n",
37 | "This library also provides an HTTP handler that can be used in an identical way, except remove `{ transport fastcgi }` from the above `Caddyfile` example. Python's standard library already includes an HTTP handler (in `http.server`), however the documentation warns that that module should not be used in production code. The HTTP handler provided here is trimmed down to a minimal implementation (just 40 lines of code) so that it can easily be studied and extended. It uses the same basic API as Python's other `socketserver` classes (and the same as `FcgiHandler` here) so there's fewer new concepts to understand."
38 | ]
39 | },
40 | {
41 | "cell_type": "markdown",
42 | "metadata": {},
43 | "source": [
44 | "## Install"
45 | ]
46 | },
47 | {
48 | "cell_type": "markdown",
49 | "metadata": {},
50 | "source": [
51 | "`pip install fastcgi` or `conda install -c fastai fastcgi`"
52 | ]
53 | },
54 | {
55 | "cell_type": "markdown",
56 | "metadata": {},
57 | "source": [
58 | "## How to use"
59 | ]
60 | },
61 | {
62 | "cell_type": "markdown",
63 | "metadata": {},
64 | "source": [
65 | "See the full docs pages for each class for details. Quick overviews of each approach are shown below."
66 | ]
67 | },
68 | {
69 | "cell_type": "markdown",
70 | "metadata": {},
71 | "source": [
72 | "### fastcgi decorator"
73 | ]
74 | },
75 | {
76 | "cell_type": "markdown",
77 | "metadata": {},
78 | "source": [
79 | "Using the `fastcgi` decorator you can use CGI scripts with minimal changes. Just add the decorator above a function used for CGI, and it converts that script automatically into a FastCGI server, e.g if you save this as `server.py`:\n",
80 | "\n",
81 | "```python\n",
82 | "@fastcgi()\n",
83 | "def hello():\n",
84 | " query = os.environ[\"QUERY_STRING\"]\n",
85 | " content = sys.stdin.read()\n",
86 | " sys.stdout.write(f\"Content-type: text/html\\r\\n\\r\\n{content} ; \")\n",
87 | " sys.stdout.write(f\"{query}\\r\\n\")\n",
88 | "```\n",
89 | "\n",
90 | "...then if you run `python server.py` it will make a unix socket available as `fcgi.sock` in the current directory."
91 | ]
92 | },
93 | {
94 | "cell_type": "markdown",
95 | "metadata": {},
96 | "source": [
97 | "### FcgiHandler"
98 | ]
99 | },
100 | {
101 | "cell_type": "markdown",
102 | "metadata": {},
103 | "source": [
104 | "`FcgiHandler` is used in much the same way as Python's [BaseRequestHandler](https://docs.python.org/3/library/socketserver.html#request-handler-objects). Here's an example:"
105 | ]
106 | },
107 | {
108 | "cell_type": "code",
109 | "execution_count": null,
110 | "metadata": {},
111 | "outputs": [],
112 | "source": [
113 | "class TestHandler(FcgiHandler):\n",
114 | " def handle(self):\n",
115 | " print('query:', self.environ['QUERY_STRING'])\n",
116 | " print('content type:', self.environ['HTTP_CONTENT_TYPE'])\n",
117 | " print('stdin:', self['stdin'].read())\n",
118 | " self['stdout'].write(b\"Content-type: text/html\\r\\n\\r\\nfoobar\\r\\n\")"
119 | ]
120 | },
121 | {
122 | "cell_type": "markdown",
123 | "metadata": {},
124 | "source": [
125 | "You can run this using any of Python's `socketserver` classes, e.g to listen on localhost port 1234:\n",
126 | "\n",
127 | "```python\n",
128 | "with TCPServer(('localhost',1234), TestHandler) as srv:\n",
129 | " srv.handle_request()\n",
130 | "```\n",
131 | "\n",
132 | "See the API docs for `FcgiHandler` for an end-to-end example.\n",
133 | "\n",
134 | "You can also create a forking or threading server by using Python's [mixins or predefined classes](https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingMixIn).\n",
135 | "\n",
136 | "In your `handle` method, you can use the `stdin`, `stdout`, and `stderr` attributes, which each contain a `BytesIO` stream."
137 | ]
138 | },
139 | {
140 | "cell_type": "markdown",
141 | "metadata": {},
142 | "source": [
143 | "### MinimalHTTPHandler"
144 | ]
145 | },
146 | {
147 | "cell_type": "markdown",
148 | "metadata": {},
149 | "source": [
150 | "`fastcgi` also comes with the `MinimalHTTPHandler` class, which provides very similar functionality to `FcgiHandler`, but using the `HTTP` protocol instead of the `FastCGI` protocol. Here's an example:\n",
151 | "\n",
152 | "```python\n",
153 | "class _TestHandler(MinimalHTTPHandler):\n",
154 | " def handle(self):\n",
155 | " print(f'Command/path/version: {self.command} {self.path} {self.request_version}')\n",
156 | " print(self.headers)\n",
157 | " self.send_response(200)\n",
158 | " self.send_header(\"Content-Type\", \"text/plain\")\n",
159 | " self.send_header('Content-Length', '2')\n",
160 | " self.end_headers()\n",
161 | " self.wfile.write(b'ok')\n",
162 | "```\n",
163 | "\n",
164 | "You can run it with a `socketserver` server in the same way shown above for `FcgiHandler`."
165 | ]
166 | },
167 | {
168 | "cell_type": "code",
169 | "execution_count": null,
170 | "metadata": {},
171 | "outputs": [],
172 | "source": []
173 | }
174 | ],
175 | "metadata": {
176 | "kernelspec": {
177 | "display_name": "Python 3",
178 | "language": "python",
179 | "name": "python3"
180 | }
181 | },
182 | "nbformat": 4,
183 | "nbformat_minor": 2
184 | }
185 |
--------------------------------------------------------------------------------
/docs/decorator.html:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: fastcgi.decorator
4 |
5 |
6 | keywords: fastai
7 | sidebar: home_sidebar
8 |
9 | summary: "Instant fastcgi scripts by just adding a decorator"
10 | description: "Instant fastcgi scripts by just adding a decorator"
11 | nb_path: "01_decorator.ipynb"
12 | ---
13 |
22 |
23 |
253 |
254 |
255 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/02_http.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "code",
5 | "execution_count": null,
6 | "metadata": {},
7 | "outputs": [],
8 | "source": [
9 | "#default_exp http"
10 | ]
11 | },
12 | {
13 | "cell_type": "markdown",
14 | "metadata": {},
15 | "source": [
16 | "# fastcgi.http\n",
17 | "> Not actually fastcgi at all! A very simple HTTP handler, designed for python apps behind a reverse proxy"
18 | ]
19 | },
20 | {
21 | "cell_type": "code",
22 | "execution_count": null,
23 | "metadata": {},
24 | "outputs": [],
25 | "source": [
26 | "#export\n",
27 | "from http import client,HTTPStatus\n",
28 | "from socketserver import ThreadingTCPServer,StreamRequestHandler\n",
29 | "from fastcore.foundation import add_docs"
30 | ]
31 | },
32 | {
33 | "cell_type": "code",
34 | "execution_count": null,
35 | "metadata": {},
36 | "outputs": [],
37 | "source": [
38 | "from nbdev import *\n",
39 | "from fastcore.utils import *\n",
40 | "import time,socket"
41 | ]
42 | },
43 | {
44 | "cell_type": "markdown",
45 | "metadata": {},
46 | "source": [
47 | "## Python's standard library servers"
48 | ]
49 | },
50 | {
51 | "cell_type": "markdown",
52 | "metadata": {},
53 | "source": [
54 | "Python's `socketserver` classes call `handle` in a `BaseRequestHandler` subclass that you pass in to its constructor. You use a `BaseRequestHandler` with any of the server classes/mixins provided by `socketserver`."
55 | ]
56 | },
57 | {
58 | "cell_type": "code",
59 | "execution_count": null,
60 | "metadata": {},
61 | "outputs": [],
62 | "source": [
63 | "#export\n",
64 | "class ReuseThreadingServer(ThreadingTCPServer): allow_reuse_address = 1"
65 | ]
66 | },
67 | {
68 | "cell_type": "code",
69 | "execution_count": null,
70 | "metadata": {},
71 | "outputs": [
72 | {
73 | "data": {
74 | "text/markdown": [
75 | "
FastCGI is a way for front-end servers to talk to back-end workers in a (somewhat) efficient and (somewhat) simple way. Although it's been around since 1996, it is not very widely appreciated, except in the PHP community, where it is very commonly used.
35 |
It can be a great approach for hosting Python scripts, avoiding the overhead of creating a new Python process for every request (as standard CGI would otherwise require) and without requiring large dependencies, complex C projects, or fiddly deployments. fastcgi has no dependencies other than fastcore.
36 |
There's no new frameworks or concepts to learn. Just call send to send anything you like back to the client, read the parameters from params, and the input from the client from stdin.
37 |
fastcgi requires a front-end web server. If you don't already have one set up, we recommend Caddy. To forward all requests to example.com to a fastcgi server listening on port 1234 create a file called Caddyfile with the following contents, and then caddy run:
This library also provides an HTTP handler that can be used in an identical way, except remove { transport fastcgi } from the above Caddyfile example. Python's standard library already includes an HTTP handler (in http.server), however the documentation warns that that module should not be used in production code. The HTTP handler provided here is trimmed down to a minimal implementation (just 40 lines of code) so that it can easily be studied and extended. It uses the same basic API as Python's other socketserver classes (and the same as FcgiHandler here) so there's fewer new concepts to understand.
44 |
45 |
46 |
47 |
48 |
49 |
50 |
Install
51 |
52 |
53 |
54 |
55 |
56 |
pip install fastcgi or conda install -c fastai fastcgi
57 |
58 |
59 |
60 |
61 |
62 |
63 |
How to use
64 |
65 |
66 |
67 |
68 |
69 |
See the full docs pages for each class for details. Quick overviews of each approach are shown below.
70 |
71 |
72 |
73 |
74 |
75 |
76 |
fastcgi decorator
77 |
78 |
79 |
80 |
81 |
82 |
Using the fastcgi decorator you can use CGI scripts with minimal changes. Just add the decorator above a function used for CGI, and it converts that script automatically into a FastCGI server, e.g if you save this as server.py:
In your handle method, you can use the stdin, stdout, and stderr attributes, which each contain a BytesIO stream.
139 |
140 |
141 |
142 |
143 |
144 |
145 |
MinimalHTTPHandler
146 |
147 |
148 |
149 |
150 |
151 |
fastcgi also comes with the MinimalHTTPHandler class, which provides very similar functionality to FcgiHandler, but using the HTTP protocol instead of the FastCGI protocol. Here's an example:
Python's socketserver classes call handle in a BaseRequestHandler subclass that you pass in to its constructor. You use a BaseRequestHandler with any of the server classes/mixins provided by socketserver.
Mix-in class to handle each request in a new thread.
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
100 |
101 | {% endraw %}
102 |
103 |
104 |
105 |
It's easiest to use allow_reuse_address to avoid having to wait for sockets to close, especially when testing. This class adds that functionality to ThreadingTCPServer.
106 |
Here's an example of using Python's standard library features along with ReuseThreadingServer:
MinimalHTTPHandler parses the HTTP command and headers, and sets command, path, request_version, and headers. It is based on the code in Python's BaseHTTPHandler, but is greatly simplified, and made consistent with the other socketserver servers.
286 |
To send a response, call send_response(code), optionally send_header a few times, then end_headers, and finally write to wfile. For instance: