summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2014-09-13 23:00:09 -0400
committerJason R. Coombs <jaraco@jaraco.com>2014-09-13 23:00:09 -0400
commit43007bd327c0b9e40930dd7689f2c3242e634549 (patch)
tree7a23a2f0e973ee3f3083eadd4f18d82e148b9649
parent9b5e539f67bec2529e551be77866dd0c9a043dcb (diff)
parent4c1c5002a4e01d0358cc74ce2ae9f2719a73b477 (diff)
downloadcherrypy-43007bd327c0b9e40930dd7689f2c3242e634549.tar.gz
Merged in coady/cherrypy (pull request #71)
Support keyword-only arguments in dispatchers. Fixes #1077.
-rw-r--r--CHANGES.txt19
-rw-r--r--cherrypy/__init__.py2
-rw-r--r--cherrypy/_cplogging.py8
-rw-r--r--cherrypy/_cpserver.py8
-rw-r--r--cherrypy/_cptools.py2
-rw-r--r--cherrypy/_cpwsgi.py14
-rw-r--r--cherrypy/_cpwsgi_server.py2
-rw-r--r--cherrypy/lib/__init__.py23
-rw-r--r--cherrypy/lib/cptools.py41
-rw-r--r--cherrypy/lib/encoding.py15
-rw-r--r--cherrypy/lib/httpauth.py8
-rw-r--r--cherrypy/lib/httputil.py9
-rw-r--r--cherrypy/lib/static.py22
-rw-r--r--cherrypy/test/test_config.py2
-rw-r--r--cherrypy/test/test_conn.py187
-rw-r--r--cherrypy/test/test_core.py6
-rw-r--r--cherrypy/test/test_iterator.py181
-rw-r--r--cherrypy/test/test_logging.py20
-rw-r--r--cherrypy/test/test_tools.py4
-rw-r--r--cherrypy/wsgiserver/wsgiserver2.py24
-rw-r--r--cherrypy/wsgiserver/wsgiserver3.py24
-rw-r--r--docs/_static/bgsides.png (renamed from sphinx/source/_static/bgsides.png)bin6498 -> 6498 bytes
-rw-r--r--docs/_static/cpdocmain.css (renamed from sphinx/source/_static/cpdocmain.css)0
-rw-r--r--docs/_static/images/cpreturn.gif (renamed from sphinx/source/progguide/cpreturn.gif)bin6088 -> 6088 bytes
-rw-r--r--docs/_static/images/cpyield.gif (renamed from sphinx/source/progguide/cpyield.gif)bin9112 -> 9112 bytes
-rw-r--r--docs/_static/images/sushibelt.JPGbin0 -> 161186 bytes
-rw-r--r--docs/advanced.rst664
-rw-r--r--docs/basics.rst732
-rw-r--r--docs/conf.py (renamed from sphinx/source/conf.py)18
-rw-r--r--docs/config.rst (renamed from sphinx/source/tutorial/config.rst)120
-rw-r--r--docs/contribute.rst6
-rw-r--r--docs/deploy.rst602
-rw-r--r--docs/extend.rst691
-rw-r--r--docs/glossary.rst34
-rw-r--r--docs/index.rst51
-rw-r--r--docs/install.rst156
-rw-r--r--docs/intro.rst150
-rw-r--r--docs/pkg/cherrypy.lib.rst166
-rw-r--r--docs/pkg/cherrypy.process.rst46
-rw-r--r--docs/pkg/cherrypy.rst162
-rw-r--r--docs/pkg/cherrypy.scaffold.rst10
-rw-r--r--docs/pkg/cherrypy.test.rst390
-rw-r--r--docs/pkg/cherrypy.tutorial.rst94
-rw-r--r--docs/pkg/cherrypy.wsgiserver.rst46
-rw-r--r--docs/pkg/modules.rst7
-rw-r--r--docs/tutorials.rst933
-rw-r--r--docs/util/convert-trac.py (renamed from sphinx/util/convert-trac.py)0
-rw-r--r--docs/util/test-doc.py (renamed from sphinx/util/test-doc.py)0
-rw-r--r--ez_setup.py134
-rw-r--r--man/cherryd.1 (renamed from docs/cherryd.1)0
-rw-r--r--release.py127
-rw-r--r--setup.cfg3
-rw-r--r--setup.py33
-rw-r--r--sphinx/Makefile89
-rw-r--r--sphinx/make.bat113
-rw-r--r--sphinx/source/appendix/cherrypyspeed.rst521
-rw-r--r--sphinx/source/appendix/faq.rst207
-rw-r--r--sphinx/source/appendix/index.rst11
-rw-r--r--sphinx/source/appendix/success.rst87
-rw-r--r--sphinx/source/deployguide/apache.rst4
-rw-r--r--sphinx/source/deployguide/cherryd.rst56
-rw-r--r--sphinx/source/deployguide/index.rst48
-rw-r--r--sphinx/source/index.rst48
-rw-r--r--sphinx/source/intro/index.rst84
-rw-r--r--sphinx/source/intro/install.rst109
-rw-r--r--sphinx/source/intro/license.rst32
-rw-r--r--sphinx/source/intro/whycherrypy.rst105
-rw-r--r--sphinx/source/progguide/REST.rst255
-rw-r--r--sphinx/source/progguide/choosingtemplate.rst151
-rw-r--r--sphinx/source/progguide/cookies.rst51
-rw-r--r--sphinx/source/progguide/customheaders.rst76
-rw-r--r--sphinx/source/progguide/extending/customplugins.rst131
-rw-r--r--sphinx/source/progguide/extending/customtools.rst282
-rw-r--r--sphinx/source/progguide/extending/index.rst15
-rw-r--r--sphinx/source/progguide/files/downloading.rst50
-rw-r--r--sphinx/source/progguide/files/favicon.rst18
-rw-r--r--sphinx/source/progguide/files/index.rst11
-rw-r--r--sphinx/source/progguide/files/static.rst298
-rw-r--r--sphinx/source/progguide/files/uploading.rst75
-rw-r--r--sphinx/source/progguide/index.rst36
-rw-r--r--sphinx/source/progguide/responsetimeouts.rst41
-rw-r--r--sphinx/source/progguide/security.rst109
-rw-r--r--sphinx/source/progguide/streaming.rst83
-rw-r--r--sphinx/source/refman/_cpchecker.rst12
-rw-r--r--sphinx/source/refman/_cpconfig.rst18
-rw-r--r--sphinx/source/refman/_cpdispatch.rst31
-rw-r--r--sphinx/source/refman/_cperror.rst32
-rw-r--r--sphinx/source/refman/_cplogging.rst15
-rw-r--r--sphinx/source/refman/_cpreqbody.rst35
-rw-r--r--sphinx/source/refman/_cprequest.rst22
-rw-r--r--sphinx/source/refman/_cpserver.rst12
-rw-r--r--sphinx/source/refman/_cptools.rst39
-rw-r--r--sphinx/source/refman/_cptree.rst15
-rw-r--r--sphinx/source/refman/_cpwsgi.rst24
-rw-r--r--sphinx/source/refman/cherrypy.rst40
-rw-r--r--sphinx/source/refman/cperrors.gifbin12971 -> 0 bytes
-rw-r--r--sphinx/source/refman/index.rst12
-rw-r--r--sphinx/source/refman/lib/auth.rst14
-rw-r--r--sphinx/source/refman/lib/auth_basic.rst12
-rw-r--r--sphinx/source/refman/lib/auth_digest.rst26
-rw-r--r--sphinx/source/refman/lib/caching.rst26
-rw-r--r--sphinx/source/refman/lib/covercp.rst18
-rw-r--r--sphinx/source/refman/lib/cpstats.rst13
-rw-r--r--sphinx/source/refman/lib/cptools.rst49
-rw-r--r--sphinx/source/refman/lib/encoding.rst22
-rw-r--r--sphinx/source/refman/lib/httpauth.rst23
-rw-r--r--sphinx/source/refman/lib/httputil.rst41
-rw-r--r--sphinx/source/refman/lib/index.rst10
-rw-r--r--sphinx/source/refman/lib/jsontools.rst16
-rw-r--r--sphinx/source/refman/lib/profiler.rst24
-rw-r--r--sphinx/source/refman/lib/reprconf.rst29
-rw-r--r--sphinx/source/refman/lib/sessions.rst41
-rw-r--r--sphinx/source/refman/lib/static.rst19
-rw-r--r--sphinx/source/refman/lib/xmlrpc.rst17
-rw-r--r--sphinx/source/refman/process/index.rst10
-rw-r--r--sphinx/source/refman/process/plugins/daemonizer.rst47
-rw-r--r--sphinx/source/refman/process/plugins/dropprivileges.rst25
-rw-r--r--sphinx/source/refman/process/plugins/index.rst46
-rw-r--r--sphinx/source/refman/process/plugins/pidfile.rst20
-rw-r--r--sphinx/source/refman/process/plugins/signalhandler.rst39
-rw-r--r--sphinx/source/refman/process/servers.rst31
-rw-r--r--sphinx/source/refman/process/win32.rst17
-rw-r--r--sphinx/source/refman/process/wspbus.rst15
-rw-r--r--sphinx/source/refman/wsgiserver/index.rst9
-rw-r--r--sphinx/source/refman/wsgiserver/init.rst84
-rw-r--r--sphinx/source/refman/wsgiserver/ssl_builtin.rst12
-rw-r--r--sphinx/source/refman/wsgiserver/ssl_pyopenssl.rst18
-rw-r--r--sphinx/source/tutorial/REST.rst308
-rw-r--r--sphinx/source/tutorial/basics.rst148
-rw-r--r--sphinx/source/tutorial/dispatching.rst433
-rw-r--r--sphinx/source/tutorial/engine.rst76
-rw-r--r--sphinx/source/tutorial/exposing.rst76
-rw-r--r--sphinx/source/tutorial/files/songs.py82
-rw-r--r--sphinx/source/tutorial/index.rst58
-rw-r--r--sphinx/source/tutorial/tools.rst105
135 files changed, 5589 insertions, 5969 deletions
diff --git a/CHANGES.txt b/CHANGES.txt
new file mode 100644
index 00000000..76a59161
--- /dev/null
+++ b/CHANGES.txt
@@ -0,0 +1,19 @@
+-----
+3.5.0
+-----
+
+* Issue #1301: When the incoming queue is full, now reject additional
+ connections. This functionality was added to CherryPy 3.0, but
+ unintentionally lost in 3.1.
+
+-----
+3.4.0
+-----
+
+* Miscellaneous quality improvements.
+
+-----
+3.3.0
+-----
+
+CherryPy adopts semver.
diff --git a/cherrypy/__init__.py b/cherrypy/__init__.py
index 469b8cba..ce34861b 100644
--- a/cherrypy/__init__.py
+++ b/cherrypy/__init__.py
@@ -56,7 +56,7 @@ with customized or extended components. The core API's are:
These API's are described in the `CherryPy specification <https://bitbucket.org/cherrypy/cherrypy/wiki/CherryPySpec>`_.
"""
-__version__ = "3.3.0"
+__version__ = "3.5.1"
from cherrypy._cpcompat import urljoin as _urljoin, urlencode as _urlencode
from cherrypy._cpcompat import basestring, unicodestr, set
diff --git a/cherrypy/_cplogging.py b/cherrypy/_cplogging.py
index d1b99f70..554fd7ef 100644
--- a/cherrypy/_cplogging.py
+++ b/cherrypy/_cplogging.py
@@ -56,6 +56,13 @@ errors! The format of access messages is highly formalized, but the error log
isn't--it receives messages from a variety of sources (including full error
tracebacks, if enabled).
+If you are logging the access log and error log to the same source, then there
+is a possibility that a specially crafted error message may replicate an access
+log message as described in CWE-117. In this case it is the application
+developer's responsibility to manually escape data before using CherryPy's log()
+functionality, or they may create an application that is vulnerable to CWE-117.
+This would be achieved by using a custom handler escape any special characters,
+and attached as described below.
Custom Handlers
===============
@@ -249,6 +256,7 @@ class LogManager(object):
'b': dict.get(outheaders, 'Content-Length', '') or "-",
'f': dict.get(inheaders, 'Referer', ''),
'a': dict.get(inheaders, 'User-Agent', ''),
+ 'o': dict.get(inheaders, 'Host', '-'),
}
if py3k:
for k, v in atoms.items():
diff --git a/cherrypy/_cpserver.py b/cherrypy/_cpserver.py
index 1ee3ee2b..a31e7428 100644
--- a/cherrypy/_cpserver.py
+++ b/cherrypy/_cpserver.py
@@ -61,6 +61,14 @@ class Server(ServerAdapter):
socket_timeout = 10
"""The timeout in seconds for accepted connections (default 10)."""
+
+ accepted_queue_size = -1
+ """The maximum number of requests which will be queued up before
+ the server refuses to accept it (default -1, meaning no limit)."""
+
+ accepted_queue_timeout = 10
+ """The timeout in seconds for attempting to add a request to the
+ queue when the queue is full (default 10)."""
shutdown_timeout = 5
"""The time to wait for HTTP worker threads to clean up."""
diff --git a/cherrypy/_cptools.py b/cherrypy/_cptools.py
index ce574492..06a56e87 100644
--- a/cherrypy/_cptools.py
+++ b/cherrypy/_cptools.py
@@ -224,7 +224,7 @@ class HandlerWrapperTool(Tool):
self._name = name
self._priority = priority
- def callable(self, debug=False):
+ def callable(self, *args, **kwargs):
innerfunc = cherrypy.serving.request.handler
def wrap(*args, **kwargs):
diff --git a/cherrypy/_cpwsgi.py b/cherrypy/_cpwsgi.py
index 4d1fd704..f6db68b0 100644
--- a/cherrypy/_cpwsgi.py
+++ b/cherrypy/_cpwsgi.py
@@ -13,7 +13,7 @@ import cherrypy as _cherrypy
from cherrypy._cpcompat import BytesIO, bytestr, ntob, ntou, py3k, unicodestr
from cherrypy import _cperror
from cherrypy.lib import httputil
-
+from cherrypy.lib import is_closable_iterator
def downgrade_wsgi_ux_to_1x(environ):
"""Return a new environ dict for WSGI 1.x from the given WSGI u.x environ.
@@ -278,8 +278,20 @@ class AppResponse(object):
def close(self):
"""Close and de-reference the current request and response. (Core)"""
+ streaming = _cherrypy.serving.response.stream
self.cpapp.release_serving()
+ # We avoid the expense of examining the iterator to see if it's
+ # closable unless we are streaming the response, as that's the
+ # only situation where we are going to have an iterator which
+ # may not have been exhausted yet.
+ if streaming and is_closable_iterator(self.iter_response):
+ iter_close = self.iter_response.close
+ try:
+ iter_close()
+ except Exception:
+ _cherrypy.log(traceback=True, severity=40)
+
def run(self):
"""Create a Request object using environ."""
env = self.environ.get
diff --git a/cherrypy/_cpwsgi_server.py b/cherrypy/_cpwsgi_server.py
index b648bab1..874e2e9f 100644
--- a/cherrypy/_cpwsgi_server.py
+++ b/cherrypy/_cpwsgi_server.py
@@ -39,6 +39,8 @@ class CPWSGIServer(wsgiserver.CherryPyWSGIServer):
request_queue_size=self.server_adapter.socket_queue_size,
timeout=self.server_adapter.socket_timeout,
shutdown_timeout=self.server_adapter.shutdown_timeout,
+ accepted_queue_size=self.server_adapter.accepted_queue_size,
+ accepted_queue_timeout=self.server_adapter.accepted_queue_timeout,
)
self.protocol = self.server_adapter.protocol_version
self.nodelay = self.server_adapter.nodelay
diff --git a/cherrypy/lib/__init__.py b/cherrypy/lib/__init__.py
index 2c851ec4..a75a53da 100644
--- a/cherrypy/lib/__init__.py
+++ b/cherrypy/lib/__init__.py
@@ -16,6 +16,29 @@ def is_iterator(obj):
# Types which implement the protocol must return themselves when
# invoking 'iter' upon them.
return iter(obj) is obj
+
+def is_closable_iterator(obj):
+
+ # Not an iterator.
+ if not is_iterator(obj):
+ return False
+
+ # A generator - the easiest thing to deal with.
+ import inspect
+ if inspect.isgenerator(obj):
+ return True
+
+ # A custom iterator. Look for a close method...
+ if not (hasattr(obj, 'close') and callable(obj.close)):
+ return False
+
+ # ... which doesn't require any arguments.
+ try:
+ inspect.getcallargs(obj.close)
+ except TypeError:
+ return False
+ else:
+ return True
class file_generator(object):
diff --git a/cherrypy/lib/cptools.py b/cherrypy/lib/cptools.py
index 66c9c1b8..f376282c 100644
--- a/cherrypy/lib/cptools.py
+++ b/cherrypy/lib/cptools.py
@@ -354,56 +354,51 @@ Message: %(error_msg)s
username = sess.get(self.session_key)
if not username:
sess[self.session_key] = username = self.anonymous()
- if self.debug:
- cherrypy.log(
- 'No session[username], trying anonymous', 'TOOLS.SESSAUTH')
+ self._debug_message('No session[username], trying anonymous')
if not username:
url = cherrypy.url(qs=request.query_string)
- if self.debug:
- cherrypy.log('No username, routing to login_screen with '
- 'from_page %r' % url, 'TOOLS.SESSAUTH')
+ self._debug_message(
+ 'No username, routing to login_screen with from_page %(url)r',
+ locals(),
+ )
response.body = self.login_screen(url)
if "Content-Length" in response.headers:
# Delete Content-Length header so finalize() recalcs it.
del response.headers["Content-Length"]
return True
- if self.debug:
- cherrypy.log('Setting request.login to %r' %
- username, 'TOOLS.SESSAUTH')
+ self._debug_message('Setting request.login to %(username)r', locals())
request.login = username
self.on_check(username)
+ def _debug_message(self, template, context={}):
+ if not self.debug:
+ return
+ cherrypy.log(template % context, 'TOOLS.SESSAUTH')
+
def run(self):
request = cherrypy.serving.request
response = cherrypy.serving.response
path = request.path_info
if path.endswith('login_screen'):
- if self.debug:
- cherrypy.log('routing %r to login_screen' %
- path, 'TOOLS.SESSAUTH')
- return self.login_screen(**request.params)
+ self._debug_message('routing %(path)r to login_screen', locals())
+ response.body = self.login_screen()
+ return True
elif path.endswith('do_login'):
if request.method != 'POST':
response.headers['Allow'] = "POST"
- if self.debug:
- cherrypy.log('do_login requires POST', 'TOOLS.SESSAUTH')
+ self._debug_message('do_login requires POST')
raise cherrypy.HTTPError(405)
- if self.debug:
- cherrypy.log('routing %r to do_login' % path, 'TOOLS.SESSAUTH')
+ self._debug_message('routing %(path)r to do_login', locals())
return self.do_login(**request.params)
elif path.endswith('do_logout'):
if request.method != 'POST':
response.headers['Allow'] = "POST"
raise cherrypy.HTTPError(405)
- if self.debug:
- cherrypy.log('routing %r to do_logout' %
- path, 'TOOLS.SESSAUTH')
+ self._debug_message('routing %(path)r to do_logout', locals())
return self.do_logout(**request.params)
else:
- if self.debug:
- cherrypy.log('No special path, running do_check',
- 'TOOLS.SESSAUTH')
+ self._debug_message('No special path, running do_check')
return self.do_check()
diff --git a/cherrypy/lib/encoding.py b/cherrypy/lib/encoding.py
index 6d54ac8c..a4c2cbd6 100644
--- a/cherrypy/lib/encoding.py
+++ b/cherrypy/lib/encoding.py
@@ -4,6 +4,7 @@ import time
import cherrypy
from cherrypy._cpcompat import basestring, BytesIO, ntob, set, unicodestr
from cherrypy.lib import file_generator
+from cherrypy.lib import is_closable_iterator
from cherrypy.lib import set_vary_header
@@ -32,23 +33,27 @@ def decode(encoding=None, default_encoding='utf-8'):
if not isinstance(default_encoding, list):
default_encoding = [default_encoding]
body.attempt_charsets = body.attempt_charsets + default_encoding
-
+
class UTF8StreamEncoder:
def __init__(self, iterator):
self._iterator = iterator
-
+
def __iter__(self):
return self
-
+
def next(self):
return self.__next__()
-
+
def __next__(self):
res = next(self._iterator)
if isinstance(res, unicodestr):
res = res.encode('utf-8')
return res
-
+
+ def close(self):
+ if is_closable_iterator(self._iterator):
+ self._iterator.close()
+
def __getattr__(self, attr):
if attr.startswith('__'):
raise AttributeError(self, attr)
diff --git a/cherrypy/lib/httpauth.py b/cherrypy/lib/httpauth.py
index 66d254e6..0897ea2a 100644
--- a/cherrypy/lib/httpauth.py
+++ b/cherrypy/lib/httpauth.py
@@ -334,10 +334,14 @@ def _checkBasicResponse(auth_map, password, method='GET', encrypt=None,
**kwargs):
# Note that the Basic response doesn't provide the realm value so we cannot
# test it
+ pass_through = lambda password, username=None: password
+ encrypt = encrypt or pass_through
try:
- return encrypt(auth_map["password"], auth_map["username"]) == password
+ candidate = encrypt(auth_map["password"], auth_map["username"])
except TypeError:
- return encrypt(auth_map["password"]) == password
+ # if encrypt only takes one parameter, it's the password
+ candidate = encrypt(auth_map["password"])
+ return candidate == password
AUTH_RESPONSES = {
"basic": _checkBasicResponse,
diff --git a/cherrypy/lib/httputil.py b/cherrypy/lib/httputil.py
index 3de801d0..69a18d45 100644
--- a/cherrypy/lib/httputil.py
+++ b/cherrypy/lib/httputil.py
@@ -103,7 +103,14 @@ def get_ranges(headervalue, content_length):
# See rfc quote above.
return None
# Negative subscript (last N bytes)
- result.append((content_length - int(stop), content_length))
+ #
+ # RFC 2616 Section 14.35.1:
+ # If the entity is shorter than the specified suffix-length,
+ # the entire entity-body is used.
+ if int(stop) > content_length:
+ result.append((0, content_length))
+ else:
+ result.append((content_length - int(stop), content_length))
return result
diff --git a/cherrypy/lib/static.py b/cherrypy/lib/static.py
index d5bb9d02..a630dae6 100644
--- a/cherrypy/lib/static.py
+++ b/cherrypy/lib/static.py
@@ -1,24 +1,24 @@
+import os
+import re
+import stat
+import mimetypes
+
try:
from io import UnsupportedOperation
except ImportError:
UnsupportedOperation = object()
-import logging
-import mimetypes
+
+import cherrypy
+from cherrypy._cpcompat import ntob, unquote
+from cherrypy.lib import cptools, httputil, file_generator_limited
+
+
mimetypes.init()
mimetypes.types_map['.dwg'] = 'image/x-dwg'
mimetypes.types_map['.ico'] = 'image/x-icon'
mimetypes.types_map['.bz2'] = 'application/x-bzip2'
mimetypes.types_map['.gz'] = 'application/x-gzip'
-import os
-import re
-import stat
-import time
-
-import cherrypy
-from cherrypy._cpcompat import ntob, unquote
-from cherrypy.lib import cptools, httputil, file_generator_limited
-
def serve_file(path, content_type=None, disposition=None, name=None,
debug=False):
diff --git a/cherrypy/test/test_config.py b/cherrypy/test/test_config.py
index 8954c1a9..f9831b12 100644
--- a/cherrypy/test/test_config.py
+++ b/cherrypy/test/test_config.py
@@ -206,7 +206,7 @@ class ConfigTests(helper.CPWebCase):
if not compat.py3k:
self.getPage("/repr?key=thing3")
- self.assertBody(repr(u'test'))
+ self.assertBody(repr(unicode('test')))
self.getPage("/repr?key=complex")
self.assertBody("(3+2j)")
diff --git a/cherrypy/test/test_conn.py b/cherrypy/test/test_conn.py
index 9aa071e4..502a3ab3 100644
--- a/cherrypy/test/test_conn.py
+++ b/cherrypy/test/test_conn.py
@@ -1,5 +1,6 @@
"""Tests for TCP connection handling, including proper and timely close."""
+import httplib
import socket
import sys
import time
@@ -8,7 +9,7 @@ timeout = 1
import cherrypy
from cherrypy._cpcompat import HTTPConnection, HTTPSConnection, NotConnected
-from cherrypy._cpcompat import BadStatusLine, ntob, urlopen, unicodestr
+from cherrypy._cpcompat import BadStatusLine, ntob, tonative, urlopen, unicodestr
from cherrypy.test import webtest
from cherrypy import _cperror
@@ -133,10 +134,22 @@ class ConnectionCloseTests(helper.CPWebCase):
self.assertRaises(NotConnected, self.getPage, "/")
def test_Streaming_no_len(self):
- self._streaming(set_cl=False)
+ try:
+ self._streaming(set_cl=False)
+ finally:
+ try:
+ self.HTTP_CONN.close()
+ except (TypeError, AttributeError):
+ pass
def test_Streaming_with_len(self):
- self._streaming(set_cl=True)
+ try:
+ self._streaming(set_cl=True)
+ finally:
+ try:
+ self.HTTP_CONN.close()
+ except (TypeError, AttributeError):
+ pass
def _streaming(self, set_cl):
if cherrypy.server.protocol_version == "HTTP/1.1":
@@ -448,49 +461,53 @@ class PipelineTests(helper.CPWebCase):
# Try a page without an Expect request header first.
# Note that httplib's response.begin automatically ignores
# 100 Continue responses, so we must manually check for it.
- conn.putrequest("POST", "/upload", skip_host=True)
- conn.putheader("Host", self.HOST)
- conn.putheader("Content-Type", "text/plain")
- conn.putheader("Content-Length", "4")
- conn.endheaders()
- conn.send(ntob("d'oh"))
- response = conn.response_class(conn.sock, method="POST")
- version, status, reason = response._read_status()
- self.assertNotEqual(status, 100)
- conn.close()
+ try:
+ conn.putrequest("POST", "/upload", skip_host=True)
+ conn.putheader("Host", self.HOST)
+ conn.putheader("Content-Type", "text/plain")
+ conn.putheader("Content-Length", "4")
+ conn.endheaders()
+ conn.send(ntob("d'oh"))
+ response = conn.response_class(conn.sock, method="POST")
+ version, status, reason = response._read_status()
+ self.assertNotEqual(status, 100)
+ finally:
+ conn.close()
# Now try a page with an Expect header...
- conn.connect()
- conn.putrequest("POST", "/upload", skip_host=True)
- conn.putheader("Host", self.HOST)
- conn.putheader("Content-Type", "text/plain")
- conn.putheader("Content-Length", "17")
- conn.putheader("Expect", "100-continue")
- conn.endheaders()
- response = conn.response_class(conn.sock, method="POST")
-
- # ...assert and then skip the 100 response
- version, status, reason = response._read_status()
- self.assertEqual(status, 100)
- while True:
- line = response.fp.readline().strip()
- if line:
- self.fail(
- "100 Continue should not output any headers. Got %r" %
- line)
- else:
- break
+ try:
+ conn.connect()
+ conn.putrequest("POST", "/upload", skip_host=True)
+ conn.putheader("Host", self.HOST)
+ conn.putheader("Content-Type", "text/plain")
+ conn.putheader("Content-Length", "17")
+ conn.putheader("Expect", "100-continue")
+ conn.endheaders()
+ response = conn.response_class(conn.sock, method="POST")
- # ...send the body
- body = ntob("I am a small file")
- conn.send(body)
+ # ...assert and then skip the 100 response
+ version, status, reason = response._read_status()
+ self.assertEqual(status, 100)
+ while True:
+ line = response.fp.readline().strip()
+ if line:
+ self.fail(
+ "100 Continue should not output any headers. Got %r" %
+ line)
+ else:
+ break
- # ...get the final response
- response.begin()
- self.status, self.headers, self.body = webtest.shb(response)
- self.assertStatus(200)
- self.assertBody("thanks for '%s'" % body)
- conn.close()
+ # ...send the body
+ body = ntob("I am a small file")
+ conn.send(body)
+
+ # ...get the final response
+ response.begin()
+ self.status, self.headers, self.body = webtest.shb(response)
+ self.assertStatus(200)
+ self.assertBody("thanks for '%s'" % body)
+ finally:
+ conn.close()
class ConnectionTests(helper.CPWebCase):
@@ -717,6 +734,92 @@ class ConnectionTests(helper.CPWebCase):
remote_data_conn.close()
+def setup_upload_server():
+
+ class Root:
+ def upload(self):
+ if not cherrypy.request.method == 'POST':
+ raise AssertionError("'POST' != request.method %r" %
+ cherrypy.request.method)
+ return "thanks for '%s'" % tonative(cherrypy.request.body.read())
+ upload.exposed = True
+
+ cherrypy.tree.mount(Root())
+ cherrypy.config.update({
+ 'server.max_request_body_size': 1001,
+ 'server.socket_timeout': 10,
+ 'server.accepted_queue_size': 5,
+ 'server.accepted_queue_timeout': 0.1,
+ })
+
+import errno
+socket_reset_errors = []
+# Not all of these names will be defined for every platform.
+for _ in ("ECONNRESET", "WSAECONNRESET"):
+ if _ in dir(errno):
+ socket_reset_errors.append(getattr(errno, _))
+
+class LimitedRequestQueueTests(helper.CPWebCase):
+ setup_server = staticmethod(setup_upload_server)
+
+ def test_queue_full(self):
+ conns = []
+ overflow_conn = None
+
+ try:
+ # Make 15 initial requests and leave them open, which should use
+ # all of wsgiserver's WorkerThreads and fill its Queue.
+ import time
+ for i in range(15):
+ conn = self.HTTP_CONN(self.HOST, self.PORT)
+ conn.putrequest("POST", "/upload", skip_host=True)
+ conn.putheader("Host", self.HOST)
+ conn.putheader("Content-Type", "text/plain")
+ conn.putheader("Content-Length", "4")
+ conn.endheaders()
+ conns.append(conn)
+
+ # Now try a 16th conn, which should be closed by the server immediately.
+ overflow_conn = self.HTTP_CONN(self.HOST, self.PORT)
+ # Manually connect since httplib won't let us set a timeout
+ for res in socket.getaddrinfo(self.HOST, self.PORT, 0,
+ socket.SOCK_STREAM):
+ af, socktype, proto, canonname, sa = res
+ overflow_conn.sock = socket.socket(af, socktype, proto)
+ overflow_conn.sock.settimeout(5)
+ overflow_conn.sock.connect(sa)
+ break
+
+ overflow_conn.putrequest("GET", "/", skip_host=True)
+ overflow_conn.putheader("Host", self.HOST)
+ overflow_conn.endheaders()
+ response = overflow_conn.response_class(overflow_conn.sock, method="GET")
+ try:
+ response.begin()
+ except socket.error as exc:
+ if exc.args[0] in socket_reset_errors:
+ pass # Expected.
+ else:
+ raise AssertionError("Overflow conn did not get RST. "
+ "Got %s instead" % repr(exc.args))
+ except httplib.BadStatusLine:
+ # This is a special case in OS X. Linux and Windows will
+ # RST correctly.
+ assert sys.platform == 'darwin'
+ else:
+ raise AssertionError("Overflow conn did not get RST ")
+ finally:
+ for conn in conns:
+ conn.send(ntob("done"))
+ response = conn.response_class(conn.sock, method="POST")
+ response.begin()
+ self.body = response.read()
+ self.assertBody("thanks for 'done'")
+ self.assertEqual(response.status, 200)
+ conn.close()
+ if overflow_conn:
+ overflow_conn.close()
+
class BadRequestTests(helper.CPWebCase):
setup_server = staticmethod(setup_server)
diff --git a/cherrypy/test/test_core.py b/cherrypy/test/test_core.py
index 6966d325..ae4728de 100644
--- a/cherrypy/test/test_core.py
+++ b/cherrypy/test/test_core.py
@@ -496,6 +496,12 @@ class CoreRequestHandlingTest(helper.CPWebCase):
self.getPage("/ranges/get_ranges?bytes=2-4,-1")
self.assertBody("[(2, 5), (7, 8)]")
+ # Test a suffix-byte-range longer than the content
+ # length. Note that in this test, the content length
+ # is 8 bytes.
+ self.getPage("/ranges/get_ranges?bytes=-100")
+ self.assertBody("[(0, 8)]")
+
# Get a partial file.
if cherrypy.server.protocol_version == "HTTP/1.1":
self.getPage("/ranges/slice_file", [('Range', 'bytes=2-5')])
diff --git a/cherrypy/test/test_iterator.py b/cherrypy/test/test_iterator.py
new file mode 100644
index 00000000..dcf4bc94
--- /dev/null
+++ b/cherrypy/test/test_iterator.py
@@ -0,0 +1,181 @@
+import cherrypy
+from cherrypy._cpcompat import unicodestr
+
+class IteratorBase(object):
+
+ created = 0
+ datachunk = u'butternut squash' * 256
+
+ @classmethod
+ def incr(cls):
+ cls.created += 1
+
+ @classmethod
+ def decr(cls):
+ cls.created -= 1
+
+class OurGenerator(IteratorBase):
+
+ def __iter__(self):
+ self.incr()
+ try:
+ for i in range(1024):
+ yield self.datachunk
+ finally:
+ self.decr()
+
+class OurIterator(IteratorBase):
+
+ started = False
+ closed_off = False
+ count = 0
+
+ def increment(self):
+ self.incr()
+
+ def decrement(self):
+ if not self.closed_off:
+ self.closed_off = True
+ self.decr()
+
+ def __iter__(self):
+ return self
+
+ def __next__(self):
+ if not self.started:
+ self.started = True
+ self.increment()
+ self.count += 1
+ if self.count > 1024:
+ raise StopIteration
+ return self.datachunk
+
+ next = __next__
+
+ def __del__(self):
+ self.decrement()
+
+class OurClosableIterator(OurIterator):
+
+ def close(self):
+ self.decrement()
+
+class OurNotClosableIterator(OurIterator):
+
+ # We can't close something which requires an additional argument.
+ def close(self, somearg):
+ self.decrement()
+
+class OurUnclosableIterator(OurIterator):
+ close = 'close' # not callable!
+
+from cherrypy.test import helper
+class IteratorTest(helper.CPWebCase):
+
+ @staticmethod
+ def setup_server():
+
+ class Root(object):
+
+ @cherrypy.expose
+ def count(self, clsname):
+ cherrypy.response.headers['Content-Type'] = 'text/plain'
+ return unicodestr(globals()[clsname].created)
+
+ @cherrypy.expose
+ def getall(self, clsname):
+ cherrypy.response.headers['Content-Type'] = 'text/plain'
+ return globals()[clsname]()
+
+ @cherrypy.expose
+ def stream(self, clsname):
+ return self.getall(clsname)
+ stream._cp_config = {'response.stream': True}
+
+ cherrypy.tree.mount(Root())
+
+ def test_iterator(self):
+ if cherrypy.server.protocol_version != "HTTP/1.1":
+ return self.skip()
+
+ self.PROTOCOL = "HTTP/1.1"
+
+ # Check the counts of all the classes, they should be zero.
+ closables = ['OurClosableIterator', 'OurGenerator']
+ unclosables = ['OurUnclosableIterator', 'OurNotClosableIterator']
+ all_classes = closables + unclosables
+
+ import random
+ random.shuffle(all_classes)
+
+ for clsname in all_classes:
+ self.getPage("/count/" + clsname)
+ self.assertStatus(200)
+ self.assertBody('0')
+
+ # We should also be able to read the entire content body
+ # successfully, though we don't need to, we just want to
+ # check the header.
+ for clsname in all_classes:
+ itr_conn = self.get_conn()
+ itr_conn.putrequest("GET", "/getall/" + clsname)
+ itr_conn.endheaders()
+ response = itr_conn.getresponse()
+ self.assertEqual(response.status, 200)
+ headers = response.getheaders()
+ for header_name, header_value in headers:
+ if header_name.lower() == 'content-length':
+ assert header_value == unicodestr(1024 * 16 * 256), header_value
+ break
+ else:
+ raise AssertionError('No Content-Length header found')
+
+ # As the response should be fully consumed by CherryPy
+ # before sending back, the count should still be at zero
+ # by the time the response has been sent.
+ self.getPage("/count/" + clsname)
+ self.assertStatus(200)
+ self.assertBody('0')
+
+ # Now we do the same check with streaming - some classes will
+ # be automatically closed, while others cannot.
+ stream_counts = {}
+ for clsname in all_classes:
+ itr_conn = self.get_conn()
+ itr_conn.putrequest("GET", "/stream/" + clsname)
+ itr_conn.endheaders()
+ response = itr_conn.getresponse()
+ self.assertEqual(response.status, 200)
+ response.fp.read(65536)
+
+ # Let's check the count - this should always be one.
+ self.getPage("/count/" + clsname)
+ self.assertBody('1')
+
+ # Now if we close the connection, the count should go back
+ # to zero.
+ itr_conn.close()
+ self.getPage("/count/" + clsname)
+
+ # If this is a response which should be easily closed, then
+ # we will test to see if the value has gone back down to
+ # zero.
+ if clsname in closables:
+
+ # Sometimes we try to get the answer too quickly - we
+ # will wait for 100 ms before asking again if we didn't
+ # get the answer we wanted.
+ if self.body != '0':
+ import time
+ time.sleep(0.1)
+ self.getPage("/count/" + clsname)
+
+ stream_counts[clsname] = int(self.body)
+
+ # Check that we closed off the classes which should provide
+ # easy mechanisms for doing so.
+ for clsname in closables:
+ assert stream_counts[clsname] == 0, (
+ 'did not close off stream response correctly, expected '
+ 'count of zero for %s: %s' % (clsname, stream_counts)
+ )
diff --git a/cherrypy/test/test_logging.py b/cherrypy/test/test_logging.py
index 9375494f..0c029ad7 100644
--- a/cherrypy/test/test_logging.py
+++ b/cherrypy/test/test_logging.py
@@ -105,6 +105,26 @@ class AccessLogTests(helper.CPWebCase, logtest.LogCase):
self.assertLog(-1, '] "GET %s/as_yield HTTP/1.1" 200 - "" ""'
% self.prefix())
+ def testCustomLogFormat(self):
+ '''Test a customized access_log_format string,
+ which is a feature of _cplogging.LogManager.access() '''
+
+ original_logformat = cherrypy._cplogging.LogManager.access_log_format
+ cherrypy._cplogging.LogManager.access_log_format = \
+ '{h} {l} {u} {t} "{r}" {s} {b} "{f}" "{a}" {o}' \
+ if py3k else \
+ '%(h)s %(l)s %(u)s %(t)s "%(r)s" %(s)s %(b)s "%(f)s" "%(a)s" %(o)s'
+
+ self.markLog()
+ self.getPage("/as_string", headers=[('Referer', 'REFERER'),
+ ('User-Agent', 'USERAGENT'),
+ ('Host', 'HOST')])
+ self.assertLog(-1, '%s - - [' % self.interface())
+ self.assertLog(-1, '] "GET /as_string HTTP/1.1" '
+ '200 7 "REFERER" "USERAGENT" HOST')
+
+ cherrypy._cplogging.LogManager.access_log_format = original_logformat
+
def testEscapedOutput(self):
# Test unicode in access log pieces.
self.markLog()
diff --git a/cherrypy/test/test_tools.py b/cherrypy/test/test_tools.py
index 6e593216..4fb1a555 100644
--- a/cherrypy/test/test_tools.py
+++ b/cherrypy/test/test_tools.py
@@ -108,6 +108,7 @@ class ToolTests(helper.CPWebCase):
cherrypy.tools.rotator = cherrypy.Tool('before_finalize', Rotator())
def stream_handler(next_handler, *args, **kwargs):
+ assert cherrypy.request.config.get('tools.streamer.arg') == 'arg value'
cherrypy.response.output = o = BytesIO()
try:
response = next_handler(*args, **kwargs)
@@ -126,10 +127,11 @@ class ToolTests(helper.CPWebCase):
index.exposed = True
def tarfile(self):
+ assert cherrypy.request.config.get('tools.streamer.arg') == 'arg value'
cherrypy.response.output.write(ntob('I am '))
cherrypy.response.output.write(ntob('a tarfile'))
tarfile.exposed = True
- tarfile._cp_config = {'tools.streamer.on': True}
+ tarfile._cp_config = {'tools.streamer.on': True, 'tools.streamer.arg': 'arg value'}
def euro(self):
hooks = list(cherrypy.request.hooks['before_finalize'])
diff --git a/cherrypy/wsgiserver/wsgiserver2.py b/cherrypy/wsgiserver/wsgiserver2.py
index a304922a..b64bf8b4 100644
--- a/cherrypy/wsgiserver/wsgiserver2.py
+++ b/cherrypy/wsgiserver/wsgiserver2.py
@@ -1545,12 +1545,14 @@ class ThreadPool(object):
and stop(timeout) attributes.
"""
- def __init__(self, server, min=10, max=-1):
+ def __init__(self, server, min=10, max=-1,
+ accepted_queue_size=-1, accepted_queue_timeout=10):
self.server = server
self.min = min
self.max = max
self._threads = []
- self._queue = queue.Queue()
+ self._queue = queue.Queue(maxsize=accepted_queue_size)
+ self._queue_put_timeout = accepted_queue_timeout
self.get = self._queue.get
def start(self):
@@ -1570,7 +1572,7 @@ class ThreadPool(object):
idle = property(_get_idle, doc=_get_idle.__doc__)
def put(self, obj):
- self._queue.put(obj)
+ self._queue.put(obj, block=True, timeout=self._queue_put_timeout)
if obj is _SHUTDOWNREQUEST:
return
@@ -1755,7 +1757,7 @@ class HTTPServer(object):
timeout = 10
"""The timeout in seconds for accepted connections (default 10)."""
- version = "CherryPy/3.3.0"
+ version = "CherryPy/3.5.1"
"""A version string for the HTTPServer."""
software = None
@@ -2072,7 +2074,12 @@ class HTTPServer(object):
conn.ssl_env = ssl_env
- self.requests.put(conn)
+ try:
+ self.requests.put(conn)
+ except queue.Full:
+ # Just drop the conn. TODO: write 503 back?
+ conn.close()
+ return
except socket.timeout:
# The only reason for the timeout in start() is so we can
# notice keyboard interrupts on Win32, which don't interrupt
@@ -2215,8 +2222,11 @@ class CherryPyWSGIServer(HTTPServer):
"""The version of WSGI to produce."""
def __init__(self, bind_addr, wsgi_app, numthreads=10, server_name=None,
- max=-1, request_queue_size=5, timeout=10, shutdown_timeout=5):
- self.requests = ThreadPool(self, min=numthreads or 1, max=max)
+ max=-1, request_queue_size=5, timeout=10, shutdown_timeout=5,
+ accepted_queue_size=-1, accepted_queue_timeout=10):
+ self.requests = ThreadPool(self, min=numthreads or 1, max=max,
+ accepted_queue_size=accepted_queue_size,
+ accepted_queue_timeout=accepted_queue_timeout)
self.wsgi_app = wsgi_app
self.gateway = wsgi_gateways[self.wsgi_version]
diff --git a/cherrypy/wsgiserver/wsgiserver3.py b/cherrypy/wsgiserver/wsgiserver3.py
index 88acff9a..415b51a0 100644
--- a/cherrypy/wsgiserver/wsgiserver3.py
+++ b/cherrypy/wsgiserver/wsgiserver3.py
@@ -1261,12 +1261,14 @@ class ThreadPool(object):
and stop(timeout) attributes.
"""
- def __init__(self, server, min=10, max=-1):
+ def __init__(self, server, min=10, max=-1,
+ accepted_queue_size=-1, accepted_queue_timeout=10):
self.server = server
self.min = min
self.max = max
self._threads = []
- self._queue = queue.Queue()
+ self._queue = queue.Queue(maxsize=accepted_queue_size)
+ self._queue_put_timeout = accepted_queue_timeout
self.get = self._queue.get
def start(self):
@@ -1286,7 +1288,7 @@ class ThreadPool(object):
idle = property(_get_idle, doc=_get_idle.__doc__)
def put(self, obj):
- self._queue.put(obj)
+ self._queue.put(obj, block=True, timeout=self._queue_put_timeout)
if obj is _SHUTDOWNREQUEST:
return
@@ -1466,7 +1468,7 @@ class HTTPServer(object):
timeout = 10
"""The timeout in seconds for accepted connections (default 10)."""
- version = "CherryPy/3.3.0"
+ version = "CherryPy/3.5.1"
"""A version string for the HTTPServer."""
software = None
@@ -1764,7 +1766,12 @@ class HTTPServer(object):
conn.ssl_env = ssl_env
- self.requests.put(conn)
+ try:
+ self.requests.put(conn)
+ except queue.Full:
+ # Just drop the conn. TODO: write 503 back?
+ conn.close()
+ return
except socket.timeout:
# The only reason for the timeout in start() is so we can
# notice keyboard interrupts on Win32, which don't interrupt
@@ -1906,8 +1913,11 @@ class CherryPyWSGIServer(HTTPServer):
"""The version of WSGI to produce."""
def __init__(self, bind_addr, wsgi_app, numthreads=10, server_name=None,
- max=-1, request_queue_size=5, timeout=10, shutdown_timeout=5):
- self.requests = ThreadPool(self, min=numthreads or 1, max=max)
+ max=-1, request_queue_size=5, timeout=10, shutdown_timeout=5,
+ accepted_queue_size=-1, accepted_queue_timeout=10):
+ self.requests = ThreadPool(self, min=numthreads or 1, max=max,
+ accepted_queue_size=accepted_queue_size,
+ accepted_queue_timeout=accepted_queue_timeout)
self.wsgi_app = wsgi_app
self.gateway = wsgi_gateways[self.wsgi_version]
diff --git a/sphinx/source/_static/bgsides.png b/docs/_static/bgsides.png
index 27c305fa..27c305fa 100644
--- a/sphinx/source/_static/bgsides.png
+++ b/docs/_static/bgsides.png
Binary files differ
diff --git a/sphinx/source/_static/cpdocmain.css b/docs/_static/cpdocmain.css
index 4414d472..4414d472 100644
--- a/sphinx/source/_static/cpdocmain.css
+++ b/docs/_static/cpdocmain.css
diff --git a/sphinx/source/progguide/cpreturn.gif b/docs/_static/images/cpreturn.gif
index 074ea3cd..074ea3cd 100644
--- a/sphinx/source/progguide/cpreturn.gif
+++ b/docs/_static/images/cpreturn.gif
Binary files differ
diff --git a/sphinx/source/progguide/cpyield.gif b/docs/_static/images/cpyield.gif
index e07c50aa..e07c50aa 100644
--- a/sphinx/source/progguide/cpyield.gif
+++ b/docs/_static/images/cpyield.gif
Binary files differ
diff --git a/docs/_static/images/sushibelt.JPG b/docs/_static/images/sushibelt.JPG
new file mode 100644
index 00000000..8f379b73
--- /dev/null
+++ b/docs/_static/images/sushibelt.JPG
Binary files differ
diff --git a/docs/advanced.rst b/docs/advanced.rst
new file mode 100644
index 00000000..44f54edb
--- /dev/null
+++ b/docs/advanced.rst
@@ -0,0 +1,664 @@
+.. _advanced:
+
+Advanced
+--------
+
+CherryPy has support for more advanced features that these sections
+will describe.
+
+.. contents::
+ :depth: 4
+
+.. _aliases:
+
+Set aliases to page handlers
+############################
+
+A fairly unknown, yet useful, feature provided by the :func:`cherrypy.expose`
+decorator is to support aliases.
+
+Let's use the template provided by :ref:`tutorial 03 <tut03>`:
+
+.. code-block:: python
+
+ import random
+ import string
+
+ import cherrypy
+
+ class StringGenerator(object):
+ @cherrypy.expose(['generer', 'generar'])
+ def generate(self, length=8):
+ return ''.join(random.sample(string.hexdigits, int(length)))
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(StringGenerator())
+
+In this example, we create localized aliases for
+the page handler. This means the page handler will be
+accessible via:
+
+- /generate
+- /generer (French)
+- /generar (Spanish)
+
+Obviously, your aliases may be whatever suits your needs.
+
+.. note::
+
+ The alias may be a single string or a list of them.
+
+RESTful-style dispatching
+#########################
+
+The term `RESTful URL` is sometimes used to talk about friendly URLs
+that nicely map to the entities an application exposes.
+
+.. important::
+
+ We will not enter the debate around what is restful or not but we will
+ showcase two mechanisms to implement the usual idea in your
+ CherryPy application.
+
+Let's assume you wish to create an application that exposes
+music bands and their records. Your application will probably have
+the following URLs:
+
+- http://hostname/<bandname>/
+- http://hostname/<bandname>/albums/<recordname>/
+
+It's quite clear you would not create a page handler named after
+every possible band in the world. This means you will need a page handler
+that acts as a proxy for all of them.
+
+The default dispatcher cannot deal with that scenario on its own
+because it expects page handlers to be explicitely declared in your
+source code. Luckily, CherryPy provides ways to support those use cases.
+
+.. seealso::
+
+ This section extends from this `stackoverflow response <http://stackoverflow.com/a/15789415/1363905>`_.
+
+The special _cp_dispatch method
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+``_cp_dispatch`` is a special method you declare in any of your :term:`controller`
+to massage the remaining segments before CherryPy gets to process them.
+This offers you the capacity to remove, add or otherwise handle any segment
+you wish and, even, entirely change the remaining parts.
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Band(object):
+ def __init__(self):
+ self.albums = Album()
+
+ def _cp_dispatch(self, vpath):
+ if len(vpath) == 1:
+ cherrypy.request.params['name'] = vpath.pop()
+ return self
+
+ if len(vpath) == 3:
+ cherrypy.request.params['artist'] = vpath.pop(0) # /band name/
+ vpath.pop(0) # /albums/
+ cherrypy.request.params['title'] = vpath.pop(0) # /album title/
+ return self.albums
+
+ return vpath
+
+ @cherrypy.expose
+ def index(self, name):
+ return 'About %s...' % name
+
+ class Album(object):
+ @cherrypy.expose
+ def index(self, artist, title):
+ return 'About %s by %s...' % (title, artist)
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(Band())
+
+Notice how the controller defines `_cp_dispatch`, it takes
+a single argument, the URL path info broken into its segments.
+
+The method can inspect and manipulate the list of segments,
+removing any or adding new segments at any position. The new list of
+segments is then sent to the dispatcher which will use it
+to locate the appropriate resource.
+
+In the above example, you should be able to go to the following URLs:
+
+- http://localhost:8080/nirvana/
+- http://localhost:8080/nirvana/albums/nevermind/
+
+The ``/nirvana/`` segment is associated to the band and
+the ``/nevermind/`` segment relates to the album.
+
+To achieve this, our `_cp_dispatch` method works on the idea
+that the default dispatcher matches URLs against page handler
+signatures and their position in the tree of handlers.
+
+In this case, we take the dynamic segments in the URL (band and record names),
+we inject them into the request parameters and we remove them
+from the segment lists as if they had never been there in the first place.
+
+In other words, `_cp_dispatch` makes it as if we were
+working on the following URLs:
+
+- http://localhost:8080/?artist=nirvana
+- http://localhost:8080/albums/?artist=nirvana&title=nevermind
+
+
+The popargs decorator
+^^^^^^^^^^^^^^^^^^^^^
+:func:`cherrypy.popargs` is more straightforward as it gives a name to any segment
+that CherryPy wouldn't be able to interpret otherwise. This makes the
+matching of segments with page handler signatures easier and helps CherryPy
+understand the structure of your URL.
+
+.. code-block:: python
+
+ import cherrypy
+
+ @cherrypy.popargs('name')
+ class Band(object):
+ def __init__(self):
+ self.albums = Album()
+
+ @cherrypy.expose
+ def index(self, name):
+ return 'About %s...' % name
+
+ @cherrypy.popargs('title')
+ class Album(object):
+ @cherrypy.expose
+ def index(self, name, title):
+ return 'About %s by %s...' % (title, name)
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(Band())
+
+This works similarly to `_cp_dispatch` but, as said above, is more
+explicit and localized. It says:
+
+- take the first segment and store it into a parameter name `band`
+- take again the first segment (since we removed the previous first)
+ and store it into a parameter named `title`
+
+Note that the decorator accepts more than a single binding. For instance:
+
+.. code-block:: python
+
+ @cherrypy.popargs('title')
+ class Album(object):
+ def __init__(self):
+ self.tracks = Track()
+
+ @cherrypy.popargs('num', 'track')
+ class Track(object):
+ @cherrypy.expose
+ def index(self, name, title, num, track):
+ ...
+
+This would handle the following URL:
+
+- http://localhost:8080/nirvana/albums/nevermind/track/06/polly
+
+Notice finally how the whole stack of segments is passed to each
+page handler so that you have the full context.
+
+Streaming the response body
+###########################
+
+CherryPy handles HTTP requests, packing and unpacking the low-level details,
+then passing control to your application's :term:`page handler`, which produce
+the body of the response. CherryPy allows you to return body content in a
+variety of types: a string, a list of strings, a file. CherryPy also allows you
+to *yield* content, rather than *return* content. When you use "yield", you also
+have the option of streaming the output.
+
+**In general, it is safer and easier to not stream output.** Therefore,
+streaming output is off by default. Streaming output and also using sessions
+requires a good understanding of :py:mod:`how session locks work
+<cherrypy.lib.sessions>`.
+
+The "normal" CherryPy response process
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When you provide content from your page handler, CherryPy manages the
+conversation between the HTTP server and your code like this:
+
+.. image:: _static/images/cpreturn.gif
+
+Notice that the HTTP server gathers all output first and then writes everything
+to the client at once: status, headers, and body. This works well for static or
+simple pages, since the entire response can be changed at any time, either in
+your application code, or by the CherryPy framework.
+
+How "streaming output" works with CherryPy
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When you set the config entry "response.stream" to True (and use "yield"),
+CherryPy manages the conversation between the HTTP server and your code like this:
+
+.. image:: _static/images/cpyield.gif
+
+When you stream, your application doesn't immediately pass raw body content
+back to CherryPy or to the HTTP server. Instead, it passes back a generator.
+At that point, CherryPy finalizes the status and headers, **before** the
+generator has been consumed, or has produced any output. This is necessary to
+allow the HTTP server to send the headers and pieces of the body as they become
+available.
+
+Once CherryPy has set the status and headers, it sends them to the HTTP server,
+which then writes them out to the client. From that point on, the CherryPy
+framework mostly steps out of the way, and the HTTP server essentially requests
+content directly from your application code (your page handler method).
+
+Therefore, when streaming, if an error occurs within your page handler,
+CherryPy will not catch it--the HTTP server will catch it. Because the headers
+(and potentially some of the body) have already been written to the client,
+the server *cannot* know a safe means of handling the error, and will therefore
+simply close the connection (the current, builtin servers actually write out a
+short error message in the body, but this may be changed, and is not guaranteed
+behavior for all HTTP servers you might use with CherryPy).
+
+In addition, you cannot manually modify the status or headers within your page
+handler if that handler method is a streaming generator, because the method will
+not be iterated over until after the headers have been written to the client.
+**This includes raising exceptions like HTTPError, NotFound, InternalRedirect
+and HTTPRedirect.** To use a streaming generator while modifying headers, you
+would have to return a generator that is separate from (or embedded in) your
+page handler. For example:
+
+.. code-block:: python
+
+ class Root:
+ @cherrypy.expose
+ def thing(self):
+ cherrypy.response.headers['Content-Type'] = 'text/plain'
+ if not authorized():
+ raise cherrypy.NotFound()
+ def content():
+ yield "Hello, "
+ yield "world"
+ return content()
+ thing._cp_config = {'response.stream': True}
+
+Streaming generators are sexy, but they play havoc with HTTP. CherryPy allows
+you to stream output for specific situations: pages which take many minutes to
+produce, or pages which need a portion of their content immediately output to
+the client. Because of the issues outlined above, **it is usually better to
+flatten (buffer) content rather than stream content**. Do otherwise only when
+the benefits of streaming outweigh the risks.
+
+Response timeouts
+#################
+
+CherryPy responses include 3 attributes related to time:
+
+ * ``response.time``: the :func:`time.time` at which the response began
+ * ``response.timeout``: the number of seconds to allow responses to run
+ * ``response.timed_out``: a boolean indicating whether the response has
+ timed out (default False).
+
+The request processing logic inspects the value of ``response.timed_out`` at
+various stages; if it is ever True, then :class:`TimeoutError` is raised.
+You are free to do the same within your own code.
+
+Rather than calculate the difference by hand, you can call
+``response.check_timeout`` to set ``timed_out`` for you.
+
+.. note::
+
+ The default response timeout is 300 seconds.
+
+.. _timeoutmonitor:
+
+Timeout Monitor
+^^^^^^^^^^^^^^^
+
+In addition, CherryPy includes a ``cherrypy.engine.timeout_monitor`` which
+monitors all active requests in a separate thread; periodically, it calls
+``check_timeout`` on them all. It is subscribed by default. To turn it off:
+
+.. code-block:: ini
+
+ [global]
+ engine.timeout_monitor.on: False
+
+or:
+
+.. code-block:: python
+
+ cherrypy.engine.timeout_monitor.unsubscribe()
+
+You can also change the interval (in seconds) at which the timeout monitor runs:
+
+.. code-block:: ini
+
+ [global]
+ engine.timeout_monitor.frequency: 60 * 60
+
+The default is once per minute. The above example changes that to once per hour.
+
+Deal with signals
+#################
+
+This :ref:`engine plugin <busplugins>` is instantiated automatically as
+`cherrypy.engine.signal_handler`.
+However, it is only *subscribed* automatically by :func:`cherrypy.quickstart`.
+So if you want signal handling and you're calling:
+
+.. code-block:: python
+
+ tree.mount()
+ engine.start()
+ engine.block()
+
+on your own, be sure to add before you start the engine:
+
+.. code-block:: python
+
+ engine.signals.subscribe()
+
+.. index:: Windows, Ctrl-C, shutdown
+.. _windows-console:
+
+Windows Console Events
+^^^^^^^^^^^^^^^^^^^^^^
+
+Microsoft Windows uses console events to communicate some signals, like Ctrl-C.
+When deploying CherryPy on Windows platforms, you should obtain the
+`Python for Windows Extensions <http://sourceforge.net/projects/pywin32/>`_;
+once you have them installed, CherryPy will handle Ctrl-C and other
+console events (CTRL_C_EVENT, CTRL_LOGOFF_EVENT, CTRL_BREAK_EVENT,
+CTRL_SHUTDOWN_EVENT, and CTRL_CLOSE_EVENT) automatically, shutting down the
+bus in preparation for process exit.
+
+
+Securing your server
+####################
+
+.. note::
+
+ This section is not meant as a complete guide to securing
+ a web application or ecosystem. Please review the various
+ guides provided at `OWASP <https://www.owasp.org/index.php/Main_Page>`_.
+
+
+There are several settings that can be enabled to make CherryPy pages more secure. These include:
+
+ Transmitting data:
+
+ #. Use Secure Cookies
+
+ Rendering pages:
+
+ #. Set HttpOnly cookies
+ #. Set XFrame options
+ #. Enable XSS Protection
+ #. Set the Content Security Policy
+
+An easy way to accomplish this is to set headers with a tool
+and wrap your entire CherryPy application with it:
+
+.. code-block:: python
+
+ import cherrypy
+
+ def secureheaders():
+ headers = cherrypy.response.headers
+ headers['X-Frame-Options'] = 'DENY'
+ headers['X-XSS-Protection'] = '1; mode=block'
+ headers['Content-Security-Policy'] = "default-src='self'"
+
+ # set the priority according to your needs if you are hooking something
+ # else on the 'before_finalize' hook point.
+ cherrypy.tools.secureheaders = cherrypy.Tool('before_finalize', secureheaders, priority=60)
+
+.. note::
+
+ Read more about `those headers <https://www.owasp.org/index.php/List_of_useful_HTTP_headers>`_.
+
+Then, in the :ref:`configuration file <config>` (or any other place that you want to enable the tool):
+
+.. code-block:: ini
+
+ [/]
+ tools.secureheaders.on = True
+
+
+If you use :ref:`sessions <basicsession>` you can also enable these settings:
+
+.. code-block:: ini
+
+ [/]
+ tools.sessions.on = True
+ # increase security on sessions
+ tools.sessions.secure = True
+ tools.sessions.httponly = True
+
+
+If you use SSL you can also enable Strict Transport Security:
+
+.. code-block:: python
+
+ # add this to secureheaders():
+ # only add Strict-Transport headers if we're actually using SSL; see the ietf spec
+ # "An HSTS Host MUST NOT include the STS header field in HTTP responses
+ # conveyed over non-secure transport"
+ # http://tools.ietf.org/html/draft-ietf-websec-strict-transport-sec-14#section-7.2
+ if (cherrypy.server.ssl_certificate != None and cherrypy.server.ssl_private_key != None):
+ headers['Strict-Transport-Security'] = 'max-age=31536000' # one year
+
+Next, you should probably use :ref:`SSL <ssl>`.
+
+Multiple HTTP servers support
+#############################
+
+CherryPy starts its own HTTP server whenever you start the
+engine. In some cases, you may wish to host your application
+on more than a single port. This is easily achieved:
+
+.. code-block:: python
+
+ from cherrypy._cpserver import Server
+ server = Server()
+ server.socket_port = 8090
+ server.subscribe()
+
+You can create as many :class:`server <cherrypy._cpserver.Server>`
+server instances as you need, once :ref:`subscribed <busplugins>`,
+they will follow the CherryPy engine's life-cycle.
+
+WSGI support
+############
+
+CherryPy supports the WSGI interface defined in :pep:`333`
+as well as its updates in :pep:`3333`. It means the following:
+
+- You can host a foreign WSGI application with the CherryPy server
+- A CherryPy application can be hosted by another WSGI server
+
+Make your CherryPy application a WSGI application
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A WSGI application can be obtained from your application as follows:
+
+.. code-block:: python
+
+ import cherrypy
+ wsgiapp = cherrypy.Application(StringGenerator(), '/', config=myconf)
+
+Simply use the `wsgiapp` instance in any WSGI-aware server.
+
+.. _hostwsgiapp:
+
+Host a foreign WSGI application in CherryPy
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Assuming you have a WSGI-aware application, you can host it
+in your CherryPy server using the :meth:`cherrypy.tree.graft <cherrypy._cptree.Tree.graft>`
+facility.
+
+.. code-block:: python
+
+ def raw_wsgi_app(environ, start_response):
+ status = '200 OK'
+ response_headers = [('Content-type','text/plain')]
+ start_response(status, response_headers)
+ return ['Hello world!']
+
+ cherrypy.tree.graft(raw_wsgi_app, '/')
+
+.. important::
+
+ You cannot use tools with a foreign WSGI application.
+ However, you can still benefit from the
+ :ref:`CherryPy bus <buspattern>`.
+
+
+No need for the WSGI interface?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The default CherryPy HTTP server supports the WSGI interfaces
+defined in :pep:`333` and :pep:`3333`. However, if your application
+is a pure CherryPy application, you can switch to a HTTP
+server that by-passes the WSGI layer altogether. It will provide
+a slight performance increase.
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello World!"
+
+ if __name__ == '__main__':
+ from cherrypy._cpnative_server import CPHTTPServer
+ cherrypy.server.httpserver = CPHTTPServer(cherrypy.server)
+
+ cherrypy.quickstart(Root(), '/')
+
+.. important::
+
+ Using the native server, you will not be able to
+ graft a WSGI application as shown in the previous section.
+ Doing so will result in a server error at runtime.
+
+WebSocket support
+#################
+
+`WebSocket <http://tools.ietf.org/html/rfc6455>`_
+is a recent application protocol that came to life
+from the HTML5 working-group in response to the needs for
+bi-directional communication. Various hacks had been proposed
+such as Comet, polling, etc.
+
+WebSocket is a socket that starts its life from a HTTP upgrade request.
+Once the upgrade is performed, the underlying socket is
+kept opened but not used in a HTTP context any longer.
+Instead, both connected endpoints may use the socket
+to push data to the other end.
+
+CherryPy itself does not support WebSocket, but the feature
+is provided by an external library called
+`ws4py <https://github.com/Lawouach/WebSocket-for-Python>`_.
+
+Database support
+################
+
+CherryPy does not bundle any database access but its architecture
+makes it easy to integrate common database interfaces such as
+the DB-API specified in :pep:`249`. Alternatively, you can also
+use an `ORM <en.wikipedia.org/wiki/Object-relational_mapping>`_
+such as `SQLAlchemy <http://sqlalchemy.readthedocs.org>`_
+or `SQLObject <https://pypi.python.org/pypi/SQLObject/>`_.
+
+You will find `here <https://bitbucket.org/Lawouach/cherrypy-recipes/src/tip/web/database/sql_alchemy/>`_
+a recipe on how integrating SQLAlchemy using a mix of
+:ref:`plugins <busplugins>` and :ref:`tools <tools>`.
+
+HTML Templating support
+#######################
+
+CherryPy does not provide any HTML template but its architecture
+makes it easy to integrate one. Popular ones are `Mako <www.makotemplates.org>`_
+or `Jinja2 <jinja.pocoo.org/docs/>`_.
+
+You will find `here <https://bitbucket.org/Lawouach/cherrypy-recipes/src/tip/web/templating/>`_
+a recipe on how to integrate them using a mix
+:ref:`plugins <busplugins>` and :ref:`tools <tools>`.
+
+Testing your application
+########################
+
+Web applications, like any other kind of code, must be tested. CherryPy provides
+a :class:`helper class <cherrypy.test.helper.CPWebCase>` to ease writing
+functional tests.
+
+Here is a simple example for a basic echo application:
+
+.. code-block:: python
+
+ import cherrypy
+ from cherrypy.test import helper
+
+ class SimpleCPTest(helper.CPWebCase):
+ def setup_server():
+ class Root(object):
+ @cherrypy.expose
+ def echo(self, message):
+ return message
+
+ cherrypy.tree.mount(Root())
+ setup_server = staticmethod(setup_server)
+
+ def test_message_should_be_returned_as_is(self):
+ self.getPage("/echo?message=Hello%20world")
+ self.assertStatus('200 OK')
+ self.assertHeader('Content-Type', 'text/html;charset=utf-8')
+ self.assertBody('Hello world')
+
+ def test_non_utf8_message_will_fail(self):
+ """
+ CherryPy defaults to decode the query-string
+ using UTF-8, trying to send a query-string with
+ a different encoding will raise a 404 since
+ it considers it's a different URL.
+ """
+ self.getPage("/echo?message=A+bient%F4t",
+ headers=[
+ ('Accept-Charset', 'ISO-8859-1,utf-8'),
+ ('Content-Type', 'text/html;charset=ISO-8859-1')
+ ]
+ )
+ self.assertStatus('404 Not Found')
+
+As you can see the, test inherits from that helper class. You should
+setup your application and mount it as per-usual. Then, define your various
+tests and call the helper :meth:`~cherrypy.test.helper.CPWebCase.getPage`
+method to perform a request. Simply use the various specialized
+assert* methods to validate your workflow and data.
+
+You can then run the test using `py.test <http://pytest.org/latest/>`_ as follows:
+
+.. code-block:: bash
+
+ $ py.test -s test_echo_app.py
+
+The ``-s`` is necessary because the CherryPy class also wraps stdin and stdout.
+
+.. note::
+
+ Although they are written using the typical pattern the
+ :mod:`unittest` module supports, they are not bare unit tests.
+ Indeed, a whole CherryPy stack is started for you and runs your application.
+ If you want to really unit test your CherryPy application, meaning without
+ having to start a server, you may want to have a look at
+ this `recipe <https://bitbucket.org/Lawouach/cherrypy-recipes/src/tip/testing/unit/serverless/>`_.
diff --git a/docs/basics.rst b/docs/basics.rst
new file mode 100644
index 00000000..8129fc45
--- /dev/null
+++ b/docs/basics.rst
@@ -0,0 +1,732 @@
+.. _basics:
+
+Basics
+------
+
+The following sections will drive you through the basics of
+a CherryPy application, introducing some essential concepts.
+
+.. contents::
+ :depth: 4
+
+The one-minute application example
+##################################
+
+The most basic application you can write with CherryPy
+involves almost all its core concepts.
+
+.. code-block:: python
+ :linenos:
+
+ import cherrypy
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello World!"
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(Root(), '/')
+
+
+First and foremost, for most tasks, you will never need more than
+a single import statement as demonstrated in line 1.
+
+Before discussing the meat, let's jump to line 9 which shows,
+how to host your application with the CherryPy application server
+and serve it with its builtin HTTP server at the `'/'` path.
+All in one single line. Not bad.
+
+Let's now step back to the actual application. Even though CherryPy
+does not mandate it, most of the time your applications
+will be written as Python classes. Methods of those classes will
+be called by CherryPy to respond to client requests. However,
+CherryPy needs to be aware that a method can be used that way, we
+say the method needs to be :term:`exposed`. This is precisely
+what the :func:`cherrypy.expose()` decorator does in line 4.
+
+Save the snippet in a file named `myapp.py` and run your first
+CherryPy application:
+
+.. code-block:: bash
+
+ $ python myapp.py
+
+Then point your browser at http://127.0.0.1:8080. Tada!
+
+
+.. note::
+
+ CherryPy is a small framework that focuses on one single task:
+ take a HTTP request and locate the most appropriate
+ Python function or method that match the request's URL.
+ Unlike other well-known frameworks, CherryPy does not
+ provide a built-in support for database access, HTML
+ templating or any other middleware nifty features.
+
+ In a nutshell, once CherryPy has found and called an
+ :term:`exposed` method, it is up to you, as a developer, to
+ provide the tools to implement your application's logic.
+
+ CherryPy takes the opinion that you, the developer, know best.
+
+.. warning::
+
+ The previous example demonstrated the simplicty of the
+ CherryPy interface but, your application will likely
+ contain a few other bits and pieces: static service,
+ more complex structure, database access, etc.
+ This will be developed in the tutorial section.
+
+
+CherryPy is a minimal framework but not a bare one, it comes
+with a few basic tools to cover common usages that you would
+expect.
+
+Hosting one or more applications
+################################
+
+A web application needs an HTTP server to be accessed to. CherryPy
+provides its own, production ready, HTTP server. There are two
+ways to host an application with it. The simple one and the almost-as-simple one.
+
+Single application
+^^^^^^^^^^^^^^^^^^
+
+The most straightforward way is to use :func:`cherrypy.quickstart`
+function. It takes at least one argument, the instance of the
+application to host. Two other settings are optionals. First, the
+base path at which the application will be accessible from. Second,
+a config dictionary or file to configure your application.
+
+.. code-block:: python
+
+ cherrypy.quickstart(Blog())
+ cherrypy.quickstart(Blog(), '/blog')
+ cherrypy.quickstart(Blog(), '/blog', {'/': {'tools.gzip.on': True}})
+
+The first one means that your application will be available at
+http://hostname:port/ whereas the other two will make your blog
+application available at http://hostname:port/blog. In addition,
+the last one provides specific settings for the application.
+
+.. note::
+
+ Notice in the third case how the settings are still
+ relative to the application, not where it is made available at,
+ hence the `{'/': ... }` rather than a `{'/blog': ... }`
+
+
+Multiple applications
+^^^^^^^^^^^^^^^^^^^^^
+
+The :func:`cherrypy.quickstart` approach is fine for a single application,
+but lacks the capacity to host several applications with the server.
+To achieve this, one must use the :meth:`cherrypy.tree.mount <cherrypy._cptree.Tree.mount>`
+function as follows:
+
+.. code-block:: python
+
+ cherrypy.tree.mount(Blog(), '/blog', blog_conf)
+ cherrypy.tree.mount(Forum(), '/forum', forum_conf)
+
+ cherrypy.engine.start()
+ cherrypy.engine.block()
+
+Essentially, :meth:`cherrypy.tree.mount <cherrypy._cptree.Tree.mount>`
+takes the same parameters as :func:`cherrypy.quickstart`: an :term:`application`,
+a hosting path segment and a configuration. The last two lines
+are simply starting application server.
+
+.. important::
+
+ :func:`cherrypy.quickstart` and :meth:`cherrypy.tree.mount <cherrypy._cptree.Tree.mount>`
+ are not exclusive. For instance, the previous lines can be written as:
+
+ .. code-block:: python
+
+ cherrypy.tree.mount(Blog(), '/blog', blog_conf)
+ cherrypy.quickstart(Forum(), '/forum', forum_conf)
+
+.. note::
+
+ You can also :ref:`host foreign WSGI application <hostwsgiapp>`.
+
+
+Logging
+#######
+
+Logging is an important task in any application. CherryPy will
+log all incoming requests as well as protocol errors.
+
+To do so, CherryPy manages two loggers:
+
+- an access one that logs every incoming requests
+- an application/error log that traces errors or other application-level messages
+
+Your application may leverage that second logger by calling
+:func:`cherrypy.log() <cherrypy._cplogging.LogManager.error>`.
+
+.. code-block:: python
+
+ cherrypy.log("hello there")
+
+You can also log an exception:
+
+.. code-block:: python
+
+ try:
+ ...
+ except:
+ cherrypy.log("kaboom!", traceback=True)
+
+Both logs are writing to files identified by the following keys
+in your configuration:
+
+- ``log.access_file`` for incoming requests using the
+ `common log format <http://en.wikipedia.org/wiki/Common_Log_Format>`_
+- ``log.error_file`` for the other log
+
+.. seealso::
+
+ Refer to the :mod:`cherrypy._cplogging` module for more
+ details about CherryPy's logging architecture.
+
+Disable logging
+^^^^^^^^^^^^^^^
+
+You may be interested in disabling either logs.
+
+To disable file logging, simply set a en empty string to the
+``log.access_file`` or ``log.error_file`` keys in your
+:ref:`global configuration <globalsettings>`.
+
+To disable, console logging, set ``log.screen`` to `False`.
+
+
+Play along with your other loggers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Your application may obviously already use the :mod:`logging`
+module to trace application level messages. CherryPy will not
+interfere with them as long as your loggers are explicitely
+named. This would work nicely:
+
+.. code-block:: python
+
+ import logging
+ logger = logging.getLogger('myapp.mypackage')
+ logger.setLevel(logging.INFO)
+ stream = logging.StreamHandler()
+ stream.setLevel(logging.INFO)
+ logger.addHandler(stream)
+
+.. _config:
+
+Configuring
+###########
+
+CherryPy comes with a fine-grained configuration mechanism and
+settings can be set at various levels.
+
+.. seealso::
+
+ Once you have the reviewed the basics, please refer
+ to the :ref:`in-depth discussion <configindepth>`
+ around configuration.
+
+.. _globalsettings:
+
+Global server configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To configure the HTTP and application servers,
+use the :meth:`cherrypy.config.update() <cherrypy._cpconfig.Config.update>`
+method.
+
+.. code-block:: python
+
+ cherrypy.config.update({'server.socket_port': 9090})
+
+The :mod:`cherrypy.config <cherrypy._cpconfig>` object is a dictionary and the
+update method merges the passed dictionary into it.
+
+You can also pass a file instead (assuming a `server.conf`
+file):
+
+.. code-block:: ini
+
+ [global]
+ server.socket_port: 9090
+
+.. code-block:: python
+
+ cherrypy.config.update("server.conf")
+
+.. warning::
+
+ :meth:`cherrypy.config.update() <cherrypy._cpconfig.Config.update>`
+ is not meant to be used to configure the application.
+ It is a common mistake. It is used to configure the server and engine.
+
+.. _perappconf:
+
+Per-application configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To configure your application, pass in a dictionary or a file
+when you associate their application to the server.
+
+.. code-block:: python
+
+ cherrypy.quickstart(myapp, '/', {'/': {'tools.gzip.on': True}})
+
+or via a file (called `app.conf` for instance):
+
+.. code-block:: ini
+
+ [/]
+ tools.gzip.on: True
+
+.. code-block:: python
+
+ cherrypy.quickstart(myapp, '/', "app.conf")
+
+Although, you can define most of your configuration in a global
+fashion, it is sometimes convenient to define them
+where they are applied in the code.
+
+.. code-block:: python
+
+ class Root(object):
+ @cherrypy.expose
+ @cherrypy.tools.gzip()
+ def index(self):
+ return "hello world!"
+
+A variant notation to the above:
+
+.. code-block:: python
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "hello world!"
+ index._cp_config = {'tools.gzip.on': True}
+
+Both methods have the same effect so pick the one
+that suits your style best.
+
+Additional application settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can add settings that are not specific to a request URL
+and retrieve them from your page handler as follows:
+
+.. code-block:: ini
+
+ [/]
+ tools.gzip.on: True
+
+ [googleapi]
+ key = "..."
+ appid = "..."
+
+.. code-block:: python
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ google_appid = cherrypy.request.app.config['googleapi']['appid']
+ return "hello world!"
+
+ cherrypy.quickstart(Root(), '/', "app.conf")
+
+
+Cookies
+#######
+
+CherryPy uses the :mod:`Cookie` module from python and in particular the
+:class:`Cookie.SimpleCookie` object type to handle cookies.
+
+- To send a cookie to a browser, set ``cherrypy.response.cookie[key] = value``.
+- To retrieve a cookie sent by a browser, use ``cherrypy.request.cookie[key]``.
+- To delete a cookie (on the client side), you must *send* the cookie with its
+ expiration time set to `0`:
+
+.. code-block:: python
+
+ cherrypy.response.cookie[key] = value
+ cherrypy.response.cookie[key]['expires'] = 0
+
+It's important to understand that the request cookies are **not** automatically
+copied to the response cookies. Clients will send the same cookies on every
+request, and therefore ``cherrypy.request.cookie`` should be populated each
+time. But the server doesn't need to send the same cookies with every response;
+therefore, ``cherrypy.response.cookie`` will usually be empty. When you wish
+to “delete” (expire) a cookie, therefore, you must set
+``cherrypy.response.cookie[key] = value`` first, and then set its ``expires``
+attribute to 0.
+
+Extended example:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class MyCookieApp(object):
+ @cherrypy.expose
+ def set(self):
+ cookie = cherrypy.response.cookie
+ cookie['cookieName'] = 'cookieValue'
+ cookie['cookieName']['path'] = '/'
+ cookie['cookieName']['max-age'] = 3600
+ cookie['cookieName']['version'] = 1
+ return "<html><body>Hello, I just sent you a cookie</body></html>"
+
+ @cherrypy.expose
+ def read(self):
+ cookie = cherrypy.request.cookie
+ res = """<html><body>Hi, you sent me %s cookies.<br />
+ Here is a list of cookie names/values:<br />""" % len(cookie)
+ for name in cookie.keys():
+ res += "name: %s, value: %s<br>" % (name, cookie[name].value)
+ return res + "</body></html>"
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(MyCookieApp(), '/cookie')
+
+
+.. _basicsession:
+
+Using sessions
+##############
+
+Sessions are one of the most common mechanism used by developers to
+identify users and synchronize their activity. By default, CherryPy
+does not activate sessions because it is not a mandatory feature
+to have, to enable it simply add the following settings in your
+configuration:
+
+.. code-block:: ini
+
+ [/]
+ tools.sessions.on: True
+
+.. code-block:: python
+
+ cherrypy.quickstart(myapp, '/', "app.conf")
+
+Sessions are, by default, stored in RAM so, if you restart your server
+all of your current sessions will be lost. You can store them in memcached
+or on the filesystem instead.
+
+Using sessions in your applications is done as follows:
+
+.. code-block:: python
+
+ import cherrypy
+
+ @cherrypy.expose
+ def index(self):
+ if 'count' not in cherrypy.session:
+ cherrypy.session['count'] = 0
+ cherrypy.session['count'] += 1
+
+In this snippet, everytime the the index page handler is called,
+the current user's session has its `'count'` key incremented by `1`.
+
+CherryPy knows which session to use by inspecting the cookie
+sent alongside the request. This cookie contains the session
+identifier used by CherryPy to load the user's session from
+the storage.
+
+.. seealso::
+
+ Refer to the :mod:`cherrypy.lib.sessions` module for more
+ details about the session interface and implementation.
+ Notably you will learn about sessions expiration.
+
+Filesystem backend
+^^^^^^^^^^^^^^^^^^
+
+Using a filesystem is a simple to not lose your sessions
+between reboots. Each session is saved in its own file within
+the given directory.
+
+.. code-block:: ini
+
+ [/]
+ tools.sessions.on: True
+ tools.sessions.storage_type = "file"
+ tools.sessions.storage_path = "/some/directorys"
+
+Memcached backend
+^^^^^^^^^^^^^^^^^
+
+`Memcached <http://memcached.org/>`_ is a popular key-store on top of your RAM,
+it is distributed and a good choice if you want to
+share sessions outside of the process running CherryPy.
+
+.. code-block:: ini
+
+ [/]
+ tools.sessions.on: True
+ tools.sessions.storage_type = "memcached"
+
+.. _staticontent:
+
+Static content serving
+######################
+
+CherryPy can serve your static content such as images, javascript and
+CSS resources, etc.
+
+.. note::
+
+ CherryPy uses the :mod:`mimetypes` module to determine the
+ best content-type to serve a particular resource. If the choice
+ is not valid, you can simply set more media-types as follows:
+
+ .. code-block:: python
+
+ import mimetypes
+ mimetypes.types_map['.csv'] = 'text/csv'
+
+
+Serving a single file
+^^^^^^^^^^^^^^^^^^^^^
+
+You can serve a single file as follows:
+
+.. code-block:: ini
+
+ [/style.css]
+ tools.staticfile.on = True
+ tools.staticfile.filename = "/home/site/style.css"
+
+CherryPy will automatically respond to URLs such as
+`http://hostname/style.css`.
+
+Serving a whole directory
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Serving a whole directory is similar to a single file:
+
+.. code-block:: ini
+
+ [/static]
+ tools.staticdir.on = True
+ tools.staticdir.dir = "/home/site/static"
+
+Assuming you have a file at `static/js/my.js`,
+CherryPy will automatically respond to URLs such as
+`http://hostname/static/js/my.js`.
+
+
+.. note::
+
+ CherryPy always requires the absolute path to the files or directories
+ it will serve. If you have several static sections to configure
+ but located in the same root directory, you can use the following
+ shortcut:
+
+
+ .. code-block:: ini
+
+ [/]
+ tools.staticdir.root = "/home/site"
+
+ [/static]
+ tools.staticdir.on = True
+ tools.staticdir.dir = "static"
+
+Allow files downloading
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Using ``"application/x-download"`` response content-type,
+you can tell a browser that a resource should be downloaded
+onto the user's machine rather than displayed.
+
+You could for instance write a page handler as follows:
+
+.. code-block:: python
+
+ from cherrypy.lib.static import serve_file
+
+ @cherrypy.expose
+ def download(self, filepath):
+ return serve_file(filepath, "application/x-download", "attachment")
+
+Assuming the filepath is a valid path on your machine, the
+response would be considered as a downloadable content by
+the browser.
+
+.. warning::
+
+ The above page handler is a security risk on its own since any file
+ of the server could be accessed (if the user running the
+ server had permissions on them).
+
+
+Dealing with JSON
+#################
+
+CherryPy has built-in support for JSON encoding and decoding
+of the request and/or response.
+
+Decoding request
+^^^^^^^^^^^^^^^^
+
+To automatically decode the content of a request using JSON:
+
+.. code-block:: python
+
+ class Root(object):
+ @cherrypy.expose
+ @cherrypy.tools.json_in()
+ def index(self):
+ data = cherrypy.request.json
+
+The `json` attribute attached to the request contains
+the decoded content.
+
+Encoding response
+^^^^^^^^^^^^^^^^^
+
+To automatically encode the content of a response using JSON:
+
+.. code-block:: python
+
+ class Root(object):
+ @cherrypy.expose
+ @cherrypy.tools.json_out()
+ def index(self):
+ return {'key': 'value'}
+
+CherryPy will encode any content returned by your page handler
+using JSON. Not all type of objects may natively be
+encoded.
+
+Authentication
+##############
+
+CherryPy provides support for two very simple authentication mechanisms,
+both described in :rfc:`2617`: Basic and Digest. They are most commonly
+known to trigger a browser's popup asking users their name
+and password.
+
+Basic
+^^^^^
+
+Basic authentication is the simplest form of authentication however
+it is not a secure one as the user's credentials are embedded into
+the request. We advise against using it unless you are running on
+SSL or within a closed network.
+
+.. code-block:: python
+
+ from cherrypy.lib import auth_basic
+
+ USERS = {'jon': 'secret'}
+
+ def validate_password(username, password):
+ if username in USERS and USERS[username] == password:
+ return True
+ return False
+
+ conf = {
+ '/protected/area': {
+ 'tools.auth_basic.on': True,
+ 'tools.auth_basic.realm': 'localhost',
+ 'tools.auth_basic.checkpassword': validate_password
+ }
+ }
+
+ cherrypy.quickstart(myapp, '/', conf)
+
+Simply put, you have to provide a function that will
+be called by CherryPy passing the username and password
+decoded from the request.
+
+The function can read its data from any source it has to: a file,
+a database, memory, etc.
+
+
+Digest
+^^^^^^
+
+Digest authentication differs by the fact the credentials
+are not carried on by the request so it's a little more secure
+than basic.
+
+CherryPy's digest support has a similar interface to the
+basic one explained above.
+
+.. code-block:: python
+
+ from cherrypy.lib import auth_digest
+
+ USERS = {'jon': 'secret'}
+
+ conf = {
+ '/protected/area': {
+ 'tools.auth_digest.on': True,
+ 'tools.auth_digest.realm': 'localhost',
+ 'tools.auth_digest.get_ha1': auth_digest.get_ha1_dict_plain(USERS),
+ 'tools.auth_digest.key': 'a565c27146791cfb'
+ }
+ }
+
+ cherrypy.quickstart(myapp, '/', conf)
+
+Favicon
+#######
+
+CherryPy serves its own sweet red cherrypy as the default
+`favicon <http://en.wikipedia.org/wiki/Favicon>`_ using the static file
+tool. You can serve your own favicon as follows:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class HelloWorld(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello World!"
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(HelloWorld(), '/',
+ {
+ '/favicon.ico':
+ {
+ 'tools.staticfile.on': True,
+ 'tools.staticfile.filename:' '/path/to/myfavicon.ico'
+ }
+ }
+ )
+
+Please refer to the :ref:`static serving <staticontent>` section
+for more details.
+
+You can also use a file to configure it:
+
+.. code-block:: ini
+
+ [/favicon.ico]
+ tools.staticfile.on: True
+ tools.staticfile.filename: "/path/to/myfavicon.ico"
+
+
+.. code-block:: python
+
+ import cherrypy
+
+ class HelloWorld(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello World!"
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(HelloWorld(), '/', app.conf)
diff --git a/sphinx/source/conf.py b/docs/conf.py
index d0fa3432..2c1ceb63 100644
--- a/sphinx/source/conf.py
+++ b/docs/conf.py
@@ -15,6 +15,12 @@
import sys
import os
+try:
+ import sphinx_rtd_theme
+ WITH_RTD_THEME = True
+except ImportError:
+ WITH_RTD_THEME = False
+
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -42,15 +48,14 @@ master_doc = 'index'
# General information about the project.
project = u'CherryPy'
-copyright = u'2013, CherryPy Team'
+copyright = u'2014, CherryPy Team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-import sys
-sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../'))
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../'))
import cherrypy
version = cherrypy.__version__
# The full version, including alpha/beta/rc tags.
@@ -99,7 +104,10 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
+if WITH_RTD_THEME:
+ html_theme = "sphinx_rtd_theme"
+else:
+ html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -121,6 +129,8 @@ html_theme = 'default'
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
+if WITH_RTD_THEME:
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
diff --git a/sphinx/source/tutorial/config.rst b/docs/config.rst
index 7d231fe9..a4eb3acc 100644
--- a/sphinx/source/tutorial/config.rst
+++ b/docs/config.rst
@@ -1,8 +1,7 @@
-:tocdepth: 3
+.. _configindepth:
-*************
-Configuration
-*************
+Configure
+---------
Configuration in CherryPy is implemented via dictionaries. Keys are strings
which name the mapped value; values may be of any type.
@@ -12,8 +11,16 @@ directly on the engine, server, request, response, and log objects. So the
best way to know the full range of what's available in the config file is to
simply import those objects and see what ``help(obj)`` tells you.
+.. note::
+
+ If you are new to CherryPy, please refer first to the simpler
+ :ref:`basic config <config>` section first.
+
+.. contents::
+ :depth: 3
+
Architecture
-============
+############
The first thing you need to know about CherryPy 3's configuration is that it
separates *global* config from *application* config. If you're deploying
@@ -27,7 +34,7 @@ context, and configuration data may apply to any of those three scopes.
Let's look at each of those scopes in turn.
Global config
--------------
+^^^^^^^^^^^^^
Global config entries apply everywhere, and are stored in
:class:`cherrypy.config <cherrypy._cpconfig.Config>`. This flat dict only holds
@@ -38,7 +45,9 @@ Global config is stored in the
:class:`cherrypy.config <cherrypy._cpconfig.Config>` dict,
and you therefore update it by calling ``cherrypy.config.update(conf)``.
The ``conf`` argument can be either a filename, an open file, or a dict of
-config entries. Here's an example of passing a dict argument::
+config entries. Here's an example of passing a dict argument:
+
+.. code-block:: python
cherrypy.config.update({'server.socket_host': '64.72.221.48',
'server.socket_port': 80,
@@ -49,7 +58,7 @@ interface CherryPy will listen. The ``server.socket_port`` option declares
the TCP port on which to listen.
Application config
-------------------
+^^^^^^^^^^^^^^^^^^
Application entries apply to a single mounted application, and are stored on
each Application object itself as
@@ -63,13 +72,17 @@ although you may also use ``app.merge(conf)``.
The ``conf`` argument can be either a filename, an open file, or a dict of
config entries.
-Configuration file example::
+Configuration file example:
+
+.. code-block:: ini
[/]
tools.trailing_slash.on = False
request.dispatch: cherrypy.dispatch.MethodDispatcher()
-or, in python code::
+or, in python code:
+
+.. code-block:: python
config = {'/':
{
@@ -82,7 +95,9 @@ or, in python code::
CherryPy only uses sections that start with ``"/"`` (except
``[global]``, see below). That means you can place your own configuration
entries in a CherryPy config file by giving them a section name which does not
-start with ``"/"``. For example, you might include database entries like this::
+start with ``"/"``. For example, you might include database entries like this:
+
+.. code-block:: ini
[global]
server.socket_host: "0.0.0.0"
@@ -100,7 +115,7 @@ via ``cherrypy.request.app.config['Databases']``. For code that is outside the
request process, you'll have to pass a reference to your Application around.
Request config
---------------
+^^^^^^^^^^^^^^
Each Request object possesses a single
:attr:`request.config <cherrypy._cprequest.Request.config>` dict. Early in the
@@ -114,24 +129,26 @@ This dict contains only those config entries which apply to the given request.
this config attribute is recalculated for the new path.
Declaration
-===========
+###########
Configuration data may be supplied as a Python dictionary, as a filename,
or as an open file object.
Configuration files
--------------------
+^^^^^^^^^^^^^^^^^^^
When you supply a filename or file, CherryPy uses Python's builtin ConfigParser;
you declare Application config by writing each path as a section header,
-and each entry as a ``"key: value"`` (or ``"key = value"``) pair::
+and each entry as a ``"key: value"`` (or ``"key = value"``) pair:
+
+.. code-block:: ini
[/path/to/my/page]
response.stream: True
tools.trailing_slash.extra = False
Combined Configuration Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you are only deploying a single application, you can make a single config
file that contains both global and app entries. Just stick the global entries
@@ -143,7 +160,7 @@ config to both places for you. But as soon as you decide to add another
application to the same site, you need to separate the two config files/dicts.
Separate Configuration Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you're deploying more than one application in the same process, you need
(1) file for global config, plus (1) file for *each* Application.
@@ -155,7 +172,9 @@ and application config is usually passed in a call to
In general, you should set global config first, and then mount each
application with its own config. Among other benefits, this allows you to set
up global logging so that, if something goes wrong while trying to mount
-an application, you'll see the tracebacks. In other words, use this order::
+an application, you'll see the tracebacks. In other words, use this order:
+
+.. code-block:: python
# global config
cherrypy.config.update({'environment': 'production',
@@ -178,7 +197,7 @@ an application, you'll see the tracebacks. In other words, use this order::
cherrypy.engine.start()
Values in config files use Python syntax
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Config entries are always a key/value pair, like ``server.socket_port = 8080``.
The key is always a name, and the value is always a Python object. That is,
@@ -186,7 +205,9 @@ if the value you are setting is an ``int`` (or other number), it needs to look
like a Python ``int``; for example, ``8080``. If the value is a string, it
needs to be quoted, just like a Python string. Arbitrary objects can also be
created, just like in Python code (assuming they can be found/imported).
-Here's an extended example, showing you some of the different types::
+Here's an extended example, showing you some of the different types:
+
+.. code-block:: ini
[global]
log.error_file: "/home/fumanchu/myapp.log"
@@ -200,17 +221,21 @@ Here's an extended example, showing you some of the different types::
.. _cp_config:
_cp_config: attaching config to handlers
-----------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Config files have a severe limitation: values are always keyed by URL.
-For example::
+For example:
+
+.. code-block:: ini
[/path/to/page]
methods_with_bodies = ("POST", "PUT", "PROPPATCH")
It's obvious that the extra method is the norm for that path; in fact,
the code could be considered broken without it. In CherryPy, you can attach
-that bit of config directly on the page handler::
+that bit of config directly on the page handler:
+
+.. code-block:: python
def page(self):
return "Hello, world!"
@@ -225,7 +250,9 @@ config dictionary is placed in
:attr:`cherrypy.request.config <cherrypy._cprequest.Request.config>`.
This can be done at any point in the tree of objects; for example, we could have
-attached that config to a class which contains the page method::
+attached that config to a class which contains the page method:
+
+.. code-block:: python
class SetOPages:
@@ -251,7 +278,7 @@ This technique allows you to:
.. _namespaces:
Namespaces
-==========
+##########
Because config entries usually just set attributes on objects, they're almost
all of the form: ``object.attribute``. A few are of the form:
@@ -262,7 +289,9 @@ as possible to the actual object referenced by the namespace; for example,
the entry ``response.stream`` actually sets the ``stream`` attribute of
:class:`cherrypy.response <cherrypy._cprequest.Response>`! In this way,
you can easily determine the default value by firing up a python interpreter
-and typing::
+and typing:
+
+.. code-block:: python
>>> import cherrypy
>>> cherrypy.response.stream
@@ -275,7 +304,7 @@ don't work like normal attributes behind the scenes; however, they still use
dotted keys and are considered to "have a namespace".
Builtin namespaces
-------------------
+^^^^^^^^^^^^^^^^^^
Entries from each namespace may be allowed in the global, application root
(``"/"``) or per-path config, or a combination:
@@ -293,7 +322,8 @@ tools X X X
========== ====== ================== =========
engine
-^^^^^^
+~~~~~~
+
Entries in this namespace controls the 'application engine'. These can only be
declared in the global config. Any attribute of
:class:`cherrypy.engine<cherrypy.process.wspbus.Bus>` may be set
@@ -312,17 +342,19 @@ in config; however, there are a few extra entries available in config:
:func:`cherrypy.quickstart`.
hooks
-^^^^^
+~~~~~
Declares additional request-processing functions. Use this to append your own
:class:`Hook<cherrypy._cprequest.Hook>` functions to the request. For example,
-to add ``my_hook_func`` to the ``before_handler`` hookpoint::
+to add ``my_hook_func`` to the ``before_handler`` hookpoint:
+
+.. code-block:: ini
[/]
hooks.before_handler = myapp.my_hook_func
log
-^^^
+~~~
Configures logging. These can only be declared in the global config (for global
logging) or ``[/]`` config (for each application).
@@ -331,32 +363,33 @@ configurable attributes. Typically, the "access_file", "error_file", and
"screen" attributes are the most commonly configured.
request
-^^^^^^^
+~~~~~~~
Sets attributes on each Request. See the
:class:`Request<cherrypy._cprequest.Request>` class for a complete list.
response
-^^^^^^^^
+~~~~~~~~
Sets attributes on each Response. See the
:class:`Response<cherrypy._cprequest.Response>` class for a complete list.
server
-^^^^^^
+~~~~~~
+
Controls the default HTTP server via
:class:`cherrypy.server<cherrypy._cpserver.Server>` (see that class for a
complete list of configurable attributes). These can only be
declared in the global config.
tools
-^^^^^
+~~~~~
Enables and configures additional request-processing packages. See the
:doc:`/tutorial/tools` overview for more information.
wsgi
-^^^^
+~~~~
Adds WSGI middleware to an Application's "pipeline". These can only be
declared in the app's root config ("/").
@@ -370,7 +403,7 @@ declared in the app's root config ("/").
:class:`Response<cherrypy._cprequest.Response>` class.
checker
-^^^^^^^
+~~~~~~~
Controls the "checker", which looks for common errors in app state (including
config) when the engine starts. You can turn off individual checks by setting
@@ -379,7 +412,8 @@ complete list. Global config only.
Custom config namespaces
-------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^
+
You can define your own namespaces if you like, and they can do far more than
simply set attributes. The ``test/test_config`` module, for example, shows an
@@ -392,7 +426,9 @@ any config entries in its namespace. You add it to a namespaces registry
(a dict), where keys are namespace names and values are handler functions.
When a config entry for your namespace is encountered, the corresponding
handler function will be called, passing the config key and value; that is,
-``namespaces[namespace](k, v)``. For example, if you write::
+``namespaces[namespace](k, v)``. For example, if you write:
+
+.. code-block:: python
def db_namespace(k, v):
if k == 'connstring':
@@ -422,7 +458,7 @@ the handler. Context managers are defined in :pep:`343`.
.. _environments:
Environments
-============
+^^^^^^^^^^^^
The only key that does not exist in a namespace is the *"environment"* entry.
It only applies to the global config, and only when you use
@@ -435,7 +471,9 @@ entry *imports* other config entries from the following template stored in
:end-before: Sphinx end config.environments
If you find the set of existing environments (production, staging, etc) too
-limiting or just plain wrong, feel free to extend them or add new environments::
+limiting or just plain wrong, feel free to extend them or add new environments:
+
+.. code-block:: python
cherrypy._cpconfig.environments['staging']['log.screen'] = False
diff --git a/docs/contribute.rst b/docs/contribute.rst
new file mode 100644
index 00000000..94bdf2c0
--- /dev/null
+++ b/docs/contribute.rst
@@ -0,0 +1,6 @@
+
+Contribute
+----------
+
+
+To be done.
diff --git a/docs/deploy.rst b/docs/deploy.rst
new file mode 100644
index 00000000..b7bab85e
--- /dev/null
+++ b/docs/deploy.rst
@@ -0,0 +1,602 @@
+
+Deploy
+------
+
+CherryPy stands on its own, but as an application server, it is often
+located in shared or complex environments. For this reason,
+it is not uncommon to run CherryPy behind a reverse proxy
+or use other servers to host the application.
+
+.. note::
+
+ CherryPy's server has proven reliable and fast enough
+ for years now. If the volume of traffic you receive is
+ average, it will do well enough on its own. Nonetheless,
+ it is common to delegate the serving of static content
+ to more capable servers such as `nginx <http://nginx.org>`_ or
+ CDN.
+
+.. contents::
+ :depth: 3
+
+
+Run as a daemon
+###############
+
+CherryPy allows you to easily decouple the current process from the parent
+environment, using the traditional double-fork:
+
+.. code-block:: python
+
+ from cherrypy.process.plugins import Daemonizer
+ d = Daemonizer(cherrypy.engine)
+ d.subscribe()
+
+.. note::
+
+ This :ref:`engine plugin <busplugins>` is only available on
+ Unix and similar systems which provide `fork()`.
+
+If a startup error occurs in the forked children, the return code from the
+parent process will still be 0. Errors in the initial daemonizing process still
+return proper exit codes, but errors after the fork won't. Therefore, if you use
+this plugin to daemonize, don't use the return code as an accurate indicator of
+whether the process fully started. In fact, that return code only indicates if
+the process successfully finished the first fork.
+
+The plugin takes optional arguments to redirect standard streams: ``stdin``,
+``stdout``, and ``stderr``. By default, these are all redirected to
+:file:`/dev/null`, but you're free to send them to log files or elsewhere.
+
+.. warning::
+
+ You should be careful to not start any threads before this plugin runs.
+ The plugin will warn if you do so, because "...the effects of calling functions
+ that require certain resources between the call to fork() and the call to an
+ exec function are undefined". (`ref <http://www.opengroup.org/onlinepubs/000095399/functions/fork.html>`_).
+ It is for this reason that the Server plugin runs at priority 75 (it starts
+ worker threads), which is later than the default priority of 65 for the
+ Daemonizer.
+
+Run as a different user
+#######################
+
+Use this :ref:`engine plugin <busplugins>` to start your
+CherryPy site as root (for example, to listen on a privileged port like 80)
+and then reduce privileges to something more restricted.
+
+This priority of this plugin's "start" listener is slightly higher than the
+priority for `server.start` in order to facilitate the most common use:
+starting on a low port (which requires root) and then dropping to another user.
+
+.. code-block:: python
+
+ DropPrivileges(cherrypy.engine, uid=1000, gid=1000).subscribe()
+
+PID files
+#########
+
+The PIDFile :ref:`engine plugin <busplugins>` is pretty straightforward: it writes
+the process id to a file on start, and deletes the file on exit. You must
+provide a 'pidfile' argument, preferably an absolute path:
+
+.. code-block:: python
+
+ PIDFile(cherrypy.engine, '/var/run/myapp.pid').subscribe()
+
+
+Control via Supervisord
+#######################
+
+`Supervisord <http://supervisord.org>`_ is a powerful process control
+and management tool that can perform a lot of tasks around process monitoring.
+
+Below is a simple supervisor configuration for your CherryPy
+application.
+
+.. code-block:: ini
+
+ [unix_http_server]
+ file=/tmp/supervisor.sock
+
+ [supervisord]
+ logfile=/tmp/supervisord.log ; (main log file;default $CWD/supervisord.log)
+ logfile_maxbytes=50MB ; (max main logfile bytes b4 rotation;default 50MB)
+ logfile_backups=10 ; (num of main logfile rotation backups;default 10)
+ loglevel=info ; (log level;default info; others: debug,warn,trace)
+ pidfile=/tmp/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
+ nodaemon=false ; (start in foreground if true;default false)
+ minfds=1024 ; (min. avail startup file descriptors;default 1024)
+ minprocs=200 ; (min. avail process descriptors;default 200)
+
+ [rpcinterface:supervisor]
+ supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
+
+ [supervisorctl]
+ serverurl=unix:///tmp/supervisor.sock
+
+ [program:myapp]
+ command=python server.py
+ environment=PYTHONPATH=.
+ directory=.
+
+This could control your server via the ``server.py`` module as
+the application entry point.
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello World!"
+
+
+ cherrypy.config.update({'server.socket_port': 8090,
+ 'engine.autoreload_on': False,
+ 'log.access_file': './access.log',
+ 'log.error_file': './error.log'})
+ cherrypy.quickstart(Root())
+
+To take the configuration (assuming it was saved in a file
+called ``supervisor.conf``) into account:
+
+.. code-block:: bash
+
+ $ supervisord -c supervisord.conf
+ $ supervisorctl update
+
+Now, you can point your browser at http://localhost:8090/
+and it will display `Hello World!`.
+
+To stop supervisor, type:
+
+.. code-block:: bash
+
+ $ supervisorctl shutdown
+
+This will obviously shutdown your application.
+
+.. _ssl:
+
+SSL support
+###########
+
+.. note::
+
+ You may want to test your server for SSL using the services
+ from `Qualys, Inc. <https://www.ssllabs.com/ssltest/index.html>`_
+
+
+CherryPy can encrypt connections using SSL to create an https connection. This keeps your web traffic secure. Here's how.
+
+1. Generate a private key. We'll use openssl and follow the `OpenSSL Keys HOWTO <https://www.openssl.org/docs/HOWTO/keys.txt>`_.:
+
+.. code-block:: bash
+
+ $ openssl genrsa -out privkey.pem 2048
+
+You can create either a key that requires a password to use, or one without a password. Protecting your private key with a password is much more secure, but requires that you enter the password every time you use the key. For example, you may have to enter the password when you start or restart your CherryPy server. This may or may not be feasible, depending on your setup.
+
+If you want to require a password, add one of the ``-aes128``, ``-aes192`` or ``-aes256`` switches to the command above. You should not use any of the DES, 3DES, or SEED algoritms to protect your password, as they are insecure.
+
+SSL Labs recommends using 2048-bit RSA keys for security (see references section at the end).
+
+
+2. Generate a certificate. We'll use openssl and follow the `OpenSSL Certificates HOWTO <https://www.openssl.org/docs/HOWTO/certificates.txt>`_. Let's start off with a self-signed certificate for testing:
+
+.. code-block:: bash
+
+ $ openssl req -new -x509 -days 365 -key privkey.pem -out cert.pem
+
+openssl will then ask you a series of questions. You can enter whatever values are applicable, or leave most fields blank. The one field you *must* fill in is the 'Common Name': enter the hostname you will use to access your site. If you are just creating a certificate to test on your own machine and you access the server by typing 'localhost' into your browser, enter the Common Name 'localhost'.
+
+
+3. Decide whether you want to use python's built-in SSL library, or the pyOpenSSL library. CherryPy supports either.
+
+ a) *Built-in.* To use python's built-in SSL, add the following line to your CherryPy config:
+
+ .. code-block:: python
+
+ cherrypy.server.ssl_module = 'builtin'
+
+ b) *pyOpenSSL*. Because python did not have a built-in SSL library when CherryPy was first created, the default setting is to use pyOpenSSL. To use it you'll need to install it (we could recommend you install `cython <http://cython.org/>`_ first):
+
+ .. code-block:: bash
+
+ $ pip install cython, pyOpenSSL
+
+
+4. Add the following lines in your CherryPy config to point to your certificate files:
+
+.. code-block:: python
+
+ cherrypy.server.ssl_certificate = "cert.pem"
+ cherrypy.server.ssl_private_key = "privkey.pem"
+
+5. If you have a certificate chain at hand, you can also specify it:
+
+.. code-block:: python
+
+ cherrypy.server.ssl_certificate_chain = "certchain.perm"
+
+6. Start your CherryPy server normally. Note that if you are debugging locally and/or using a self-signed certificate, your browser may show you security warnings.
+
+WSGI servers
+############
+
+Embedding into another WSGI framework
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Though CherryPy comes with a very reliable and fast enough HTTP server,
+you may wish to integrate your CherryPy application within a
+different framework. To do so, we will benefit from the WSGI
+interface defined in :pep:`333` and :pep:`3333`.
+
+Note that you should follow some basic rules when embedding CherryPy
+in a third-party WSGI server:
+
+- If you rely on the `"main"` channel to be published on, as
+ it would happen within the CherryPy's mainloop, you should
+ find a way to publish to it within the other framework's mainloop.
+
+- Start the CherryPy's engine. This will publish to the `"start"` channel
+ of the bus.
+
+ .. code-block:: python
+
+ cherrypy.engine.start()
+
+- Stop the CherryPy's engine when you terminate. This will publish
+ to the `"stop"` channel of the bus.
+
+ .. code-block:: python
+
+ cherrypy.engine.stop()
+
+- Do not call ``cherrypy.engine.block()``.
+
+- Disable the built-in HTTP server since it will not be used.
+
+ .. code-block:: python
+
+ cherrypy.server.unsubscribe()
+
+- Disable autoreload. Usually other frameworks won't react well to it,
+ or sometimes, provide the same feature.
+
+ .. code-block:: python
+
+ cherrypy.config.update({'engine.autoreload.on': False})
+
+- Disable CherryPy signals handling. This may not be needed, it depends
+ on how the other framework handles them.
+
+ .. code-block:: python
+
+ cherrypy.engine.signals.subscribe()
+
+- Use the ``"embedded"`` environment configuration scheme.
+
+ .. code-block:: python
+
+ cherrypy.config.update({'environment': 'embedded'})
+
+ Essentially this will disable the following:
+
+ - Stdout logging
+ - Autoreloader
+ - Configuration checker
+ - Headers logging on error
+ - Tracebacks in error
+ - Mismatched params error during dispatching
+ - Signals (SIGHUP, SIGTERM)
+
+Tornado
+^^^^^^^
+
+You can use `tornado <http://www.tornadoweb.org/>`_ HTTP server as
+follow:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello World!"
+
+ if __name__ == '__main__':
+ import tornado
+ import tornado.httpserver
+ import tornado.wsgi
+
+ # our WSGI application
+ wsgiapp = cherrypy.tree.mount(Root())
+
+ # Disable the autoreload which won't play well
+ cherrypy.config.update({'engine.autoreload.on': False})
+
+ # let's not start the CherryPy HTTP server
+ cherrypy.server.unsubscribe()
+
+ # use CherryPy's signal handling
+ cherrypy.engine.signals.subscribe()
+
+ # Prevent CherryPy logs to be propagated
+ # to the Tornado logger
+ cherrypy.log.error_log.propagate = False
+
+ # Run the engine but don't block on it
+ cherrypy.engine.start()
+
+ # Run thr tornado stack
+ container = tornado.wsgi.WSGIContainer(wsgiapp)
+ http_server = tornado.httpserver.HTTPServer(container)
+ http_server.listen(8080)
+ # Publish to the CherryPy engine as if
+ # we were using its mainloop
+ tornado.ioloop.PeriodicCallback(lambda: cherrypy.engine.publish('main'), 100).start()
+ tornado.ioloop.IOLoop.instance().start()
+
+Twisted
+^^^^^^^
+
+You can use `Twisted <https://twistedmatrix.com/>`_ HTTP server as
+follow:
+
+.. code-block:: python
+
+ import cherrypy
+
+ from twisted.web.wsgi import WSGIResource
+ from twisted.internet import reactor
+ from twisted.internet import task
+
+ # Our CherryPy application
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "hello world"
+
+ # Create our WSGI app from the CherryPy application
+ wsgiapp = cherrypy.tree.mount(Root())
+
+ # Configure the CherryPy's app server
+ # Disable the autoreload which won't play well
+ cherrypy.config.update({'engine.autoreload.on': False})
+
+ # We will be using Twisted HTTP server so let's
+ # disable the CherryPy's HTTP server entirely
+ cherrypy.server.unsubscribe()
+
+ # If you'd rather use CherryPy's signal handler
+ # Uncomment the next line. I don't know how well this
+ # will play with Twisted however
+ #cherrypy.engine.signals.subscribe()
+
+ # Publish periodically onto the 'main' channel as the bus mainloop would do
+ task.LoopingCall(lambda: cherrypy.engine.publish('main')).start(0.1)
+
+ # Tie our app to Twisted
+ reactor.addSystemEventTrigger('after', 'startup', cherrypy.engine.start)
+ reactor.addSystemEventTrigger('before', 'shutdown', cherrypy.engine.exit)
+ resource = WSGIResource(reactor, reactor.getThreadPool(), wsgiapp)
+
+Notice how we attach the bus methods to the Twisted's own lifecycle.
+
+Save that code into a module named `cptw.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ twistd -n web --port 8080 --wsgi cptw.wsgiapp
+
+
+uwsgi
+^^^^^
+
+You can use `uwsgi <http://projects.unbit.it/uwsgi/>`_ HTTP server as
+follow:
+
+.. code-block:: python
+
+ import cherrypy
+
+ # Our CherryPy application
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "hello world"
+
+ cherrypy.config.update({'engine.autoreload.on': False})
+ cherrypy.server.unsubscribe()
+ cherrypy.engine.start()
+
+ wsgiapp = cherrypy.tree.mount(Root())
+
+Save this into a Python module called `mymod.py` and run
+it as follows:
+
+
+.. code-block:: bash
+
+ $ uwsgi --socket 127.0.0.1:8080 --protocol=http --wsgi-file mymod.py --callable wsgiapp
+
+
+Virtual Hosting
+###############
+
+CherryPy has support for virtual-hosting. It does so through
+a dispatchers that locate the appropriate resource based
+on the requested domain.
+
+Below is a simple example for it:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Root(object):
+ def __init__(self):
+ self.app1 = App1()
+ self.app2 = App2()
+
+ class App1(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello world from app1"
+
+ class App2(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello world from app2"
+
+ if __name__ == '__main__':
+ hostmap = {
+ 'company.com:8080': '/app1',
+ 'home.net:8080': '/app2',
+ }
+
+ config = {
+ 'request.dispatch': cherrypy.dispatch.VirtualHost(**hostmap)
+ }
+
+ cherrypy.quickstart(Root(), '/', {'/': config})
+
+In this example, we declare two domains and their ports:
+
+- company.com:8080
+- home.net:8080
+
+Thanks to the :class:`cherrypy.dispatch.VirtualHost` dispatcher,
+we tell CherryPy which application to dispatch to when a request
+arrives. The dispatcher looks up the requested domain and
+call the according application.
+
+.. note::
+
+ To test this example, simply add the following rules to
+ your `hosts` file:
+
+ .. code-block:: text
+
+ 127.0.0.1 company.com
+ 127.0.0.1 home.net
+
+
+
+Reverse-proxying
+################
+
+Apache
+^^^^^^
+
+Nginx
+^^^^^
+
+nginx is a fast and modern HTTP server with a small footprint. It is
+a popular choice as a reverse proxy to application servers such as
+CherryPy.
+
+This section will not cover the whole range of features nginx provides.
+Instead, it will simply provide you with a basic configuration that can
+be a good starting point.
+
+
+.. code-block:: nginx
+ :linenos:
+
+ upstream apps {
+ server 127.0.0.1:8080;
+ server 127.0.0.1:8081;
+ }
+
+ gzip_http_version 1.0;
+ gzip_proxied any;
+ gzip_min_length 500;
+ gzip_disable "MSIE [1-6]\.";
+ gzip_types text/plain text/xml text/css
+ text/javascript
+ application/javascript;
+
+ server {
+ listen 80;
+ server_name www.example.com;
+
+ access_log /app/logs/www.example.com.log combined;
+ error_log /app/logs/www.example.com.log;
+
+ location ^~ /static/ {
+ root /app/static/;
+ }
+
+ location / {
+ proxy_pass http://apps;
+ proxy_redirect off;
+ proxy_set_header Host $host;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Forwarded-Host $server_name;
+ }
+ }
+
+Edit this configuration to match your own paths. Then, save this configuration
+into a file under ``/etc/nginx/conf.d/`` (assuming Ubuntu).
+The filename is irrelevant. Then run the following commands:
+
+.. code-block:: bash
+
+ $ sudo service nginx stop
+ $ sudo service nginx start
+
+Hopefully, this will be enough to forward requests hitting
+the nginx frontend to your CherryPy application. The ``upstream``
+block defines the addresses of your CherryPy instances.
+
+It shows that you can load-balance between two application
+servers. Refer to the nginx documentation to understand
+how this achieved.
+
+.. code-block:: nginx
+
+ upstream apps {
+ server 127.0.0.1:8080;
+ server 127.0.0.1:8081;
+ }
+
+Later on, this block is used to define the reverse
+proxy section.
+
+Now, let's see our application:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "hello world"
+
+ if __name__ == '__main__':
+ cherrypy.config.update({
+ 'server.socket_port': 8080,
+ 'tools.proxy.on': True,
+ 'tools.proxy.base': 'http://www.example.com'
+ })
+ cherrypy.quickstart(Root())
+
+If you run two instances of this code, one on each
+port defined in the nginx section, you will be able
+to reach both of them via the load-balancing done
+by nginx.
+
+Notice how we define the proxy tool. It is not mandatory and
+used only so that the CherryPy request knows about the true
+client's address. Otherwise, it would know only about the
+nginx's own address. This is most visible in the logs.
+
+The ``base`` attribute should match the ``server_name``
+section of the nginx configuration.
diff --git a/docs/extend.rst b/docs/extend.rst
new file mode 100644
index 00000000..ef8bf8b5
--- /dev/null
+++ b/docs/extend.rst
@@ -0,0 +1,691 @@
+.. _extend:
+
+Extend
+------
+
+CherryPy is truly an open framework, you can extend and plug
+new functions at will either server-side or on a per-requests basis.
+Either way, CherryPy is made to help you build your
+application and support your architecture via simple patterns.
+
+.. contents::
+ :depth: 4
+
+Server-wide functions
+#####################
+
+CherryPy can be considered both as a HTTP library
+as much as a web application framework. In that latter case,
+its architecture provides mechanisms to support operations
+accross the whole server instance. This offers a powerful
+canvas to perform persistent operations as server-wide
+functions live outside the request processing itself. They
+are available to the whole process as long as the bus lives.
+
+Typical use cases:
+
+- Keeping a pool of connection to an external server so that
+ your need not to re-open them on each request (database connections
+ for instance).
+- Background processing (say you need work to be done without
+ blocking the whole request itself).
+
+
+Publish/Subscribe pattern
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+CherryPy's backbone consists of a bus system implementing
+a simple `publish/subscribe messaging pattern <http://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern>`_.
+Simply put, in CherryPy everything is controlled via that bus.
+One can easily picture the bus as a sushi restaurant's belt as in
+the picture below.
+
+.. image:: _static/images/sushibelt.JPG
+ :target: http://en.wikipedia.org/wiki/YO!_Sushi
+
+
+You can subscribe and publish to channels on a bus. A channel is
+bit like a unique identifier within the bus. When a message is
+published to a channel, the bus will dispatch the message to
+all subscribers for that channel.
+
+One interesting aspect of a pubsub pattern is that it promotes
+decoupling between a caller and the callee. A published message
+will eventually generate a response but the publisher does not
+know where that response came from.
+
+Thanks to that decoupling, a CherryPy application can easily
+access functionalities without having to hold a reference to
+the entity providing that functionality. Instead, the
+application simply publishes onto the bus and will receive
+the appropriate response, which is all that matter.
+
+.. _buspattern:
+
+Typical pattern
+~~~~~~~~~~~~~~~
+
+Let's take the following dummy application:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class ECommerce(object):
+ def __init__(self, db):
+ self.mydb = db
+
+ @cherrypy.expose
+ def save_kart(self, cart_data):
+ cart = Cart(cart_data)
+ self.mydb.save(cart)
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(ECommerce(), '/')
+
+The application has a reference to the database but
+this creates a fairly strong coupling between the
+database provider and the application.
+
+Another approach to work around the coupling is by
+using a pubsub workflow:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class ECommerce(object):
+ @cherrypy.expose
+ def save_kart(self, cart_data):
+ cart = Cart(cart_data)
+ cherrypy.engine.publish('db-save', cart)
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(ECommerce(), '/')
+
+In this example, we publish a `cart` instance to
+`db-save` channel. One or many subscribers can then
+react to that message and the application doesn't
+have to know about them.
+
+.. note::
+
+ This approach is not mandatory and it's up to you to
+ decide how to design your entities interaction.
+
+
+Implementation details
+~~~~~~~~~~~~~~~~~~~~~~
+
+CherryPy's bus implementation is simplistic as it registers
+functions to channels. Whenever a message is published to
+a channel, each registered function is applied with that
+message passas as a parameter.
+
+The whole behaviour happens synchronously and, in that sense,
+if a subscriber takes too long to process a message, the
+remaining subscribers will be delayed.
+
+CherryPy's bus is not an advanced pubsub messaging broker
+system such as provided by `zeromq <http://zeromq.org/>`_ or
+`RabbitMQ <https://www.rabbitmq.com/>`_.
+Use it with the understanding that it may have a cost.
+
+.. _cpengine:
+
+Engine as a pubsub bus
+~~~~~~~~~~~~~~~~~~~~~~
+
+As said earlier, CherryPy is built around a pubsub bus. All
+entities that the framework manages at runtime are working on
+top of a single bus instance, which is named the `engine`.
+
+The bus implementation therefore provides a set of common
+channels which describe the application's lifecycle:
+
+.. code-block:: text
+
+ O
+ |
+ V
+ STOPPING --> STOPPED --> EXITING -> X
+ A A |
+ | \___ |
+ | \ |
+ | V V
+ STARTED <-- STARTING
+
+The states' transitions trigger channels to be published
+to so that subscribers can react to them.
+
+One good example is the HTTP server which will tranisition
+from a `"STOPPED"` stated to a `"STARTED"` state whenever
+a message is published to the `start` channel.
+
+Built-in channels
+~~~~~~~~~~~~~~~~~
+
+In order to support its life-cycle, CherryPy defines a set
+of common channels that will be published to at various states:
+
+- **"start"**: When the bus is in the `"STARTING"` state
+- **"main"**: Periodically from the CherryPy's mainloop
+- **"stop"**: When the bus is in the `"STOPPING"` state
+- **"graceful"**: When the bus requests a reload of subscribers
+- **"exit"**: When the bus is in the `"EXITING"` state
+
+This channel will be published to by the `engine` automatically.
+Register therefore any subscribers that would need to react
+to the transition changes of the `engine`.
+
+In addition, a few other channels are also published to during
+the request processing.
+
+- `**"before_request"**: right before the request is processed by CherryPy
+- **"after_request"**: right after it has been processed
+
+Also, from the :class:`cherrypy.process.plugins.ThreadManager` plugin:
+
+- **"acquire_thread"**
+- **"start_thread"**
+- **"stop_thread"**
+- **"release_thread"**
+
+Bus API
+~~~~~~~
+
+In order to work with the bus, the implementation
+provides the following simple API:
+
+- :meth:`cherrypy.engine.publish(channel, *args) <cherrypy.process.wspbus.Bus.publish>`:
+ - The `channel` parameter is a string identifying the channel to
+ which the message should be sent to
+ - `*args` is the message and may contain any valid Python values or
+ objects.
+- :meth:`cherrypy.engine.subscribe(channel, callable) <cherrypy.process.wspbus.Bus.subscribe>`:
+ - The `channel` parameter is a string identifying the channel the
+ `callable` will be registered to.
+ - `callable` is a Python function or method which signature must
+ match what will be published.
+- :meth:`cherrypy.engine.unsubscribe(channel, callable) <cherrypy.process.wspbus.Bus.unsubscribe>`:
+ - The `channel` parameter is a string identifying the channel the
+ `callable` was registered to.
+ - `callable` is the Python function or method which was registered.
+
+.. _busplugins:
+
+Plugins
+^^^^^^^
+
+Plugins, simply put, are entities that play with the bus, either by
+publishing or subscribing to channels, usually both at the same time.
+
+.. important::
+
+ Plugins are extremely useful whenever you have functionalities:
+
+ - Available accross the whole application server
+ - Associated to the application's life-cycle
+ - You want to avoid being strongly coupled to the application
+
+Create a plugin
+~~~~~~~~~~~~~~~
+
+A typical plugin looks like this:
+
+.. code-block:: python
+
+ import cherrypy
+ from cherrypy.process import wspbus, plugins
+
+ class DatabasePlugin(plugins.SimplePlugin):
+ def __init__(self, bus, db_klass):
+ plugins.SimplePlugin.__init__(self, bus)
+ self.db = db_klass()
+
+ def start(self):
+ self.bus.log('Starting up DB access')
+ self.bus.subscribe("db-save", self.save_it)
+
+ def stop(self):
+ self.bus.log('Stopping down DB access')
+ self.bus.unsubscribe("db-save", self.save_it)
+
+ def save_it(self, entity):
+ self.db.save(entity)
+
+The :class:`cherrypy.process.plugins.SimplePlugin` is a helper
+class provided by CherryPy that will automatically subscribe
+your `start` and `stop` methods to the related channels.
+
+When the `start` and `stop` channels are published on, those
+methods are called accordingly.
+
+Notice then how our plugin subscribes to the `db-save`
+channel so that the bus can dispatch messages to the plugin.
+
+Enable a plugin
+~~~~~~~~~~~~~~~
+
+To enable the plugin, it has to be registered to the the
+bus as follows:
+
+.. code-block:: python
+
+ DatabasePlugin(cherrypy.engine, SQLiteDB).subscribe()
+
+The `SQLiteDB` here is a fake class that is used as our
+database provider.
+
+Disable a plugin
+~~~~~~~~~~~~~~~~
+
+You can also unregister a plugin as follows:
+
+.. code-block:: python
+
+ someplugin.unsubscribe()
+
+This is often used when you want to prevent the default
+HTTP server from being started by CherryPy, for instance
+if you run on top of a different HTTP server (WSGI capable):
+
+.. code-block:: python
+
+ cherrypy.server.unsubscribe()
+
+Let's see an example using this default application:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "hello world"
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(Root())
+
+For instance, this is what you would see when running
+this application:
+
+.. code-block:: python
+
+ [27/Apr/2014:13:04:07] ENGINE Listening for SIGHUP.
+ [27/Apr/2014:13:04:07] ENGINE Listening for SIGTERM.
+ [27/Apr/2014:13:04:07] ENGINE Listening for SIGUSR1.
+ [27/Apr/2014:13:04:07] ENGINE Bus STARTING
+ [27/Apr/2014:13:04:07] ENGINE Started monitor thread 'Autoreloader'.
+ [27/Apr/2014:13:04:07] ENGINE Started monitor thread '_TimeoutMonitor'.
+ [27/Apr/2014:13:04:08] ENGINE Serving on http://127.0.0.1:8080
+ [27/Apr/2014:13:04:08] ENGINE Bus STARTED
+
+Now let's unsubscribe the HTTP server:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Root(object):
+ @cherrypy.expose
+ def index(self):
+ return "hello world"
+
+ if __name__ == '__main__':
+ cherrypy.server.unsubscribe()
+ cherrypy.quickstart(Root())
+
+This is what we get:
+
+.. code-block:: python
+
+ [27/Apr/2014:13:08:06] ENGINE Listening for SIGHUP.
+ [27/Apr/2014:13:08:06] ENGINE Listening for SIGTERM.
+ [27/Apr/2014:13:08:06] ENGINE Listening for SIGUSR1.
+ [27/Apr/2014:13:08:06] ENGINE Bus STARTING
+ [27/Apr/2014:13:08:06] ENGINE Started monitor thread 'Autoreloader'.
+ [27/Apr/2014:13:08:06] ENGINE Started monitor thread '_TimeoutMonitor'.
+ [27/Apr/2014:13:08:06] ENGINE Bus STARTED
+
+As you can see, the server is not started. The missing:
+
+.. code-block:: python
+
+ [27/Apr/2014:13:04:08] ENGINE Serving on http://127.0.0.1:8080
+
+Per-request functions
+#####################
+
+One of the most common task in a web application development
+is to tailor the request's processing to the runtime context.
+
+Within CherryPy, this is performed via what are called `tools`.
+If you are familiar with Django or WSGI middlewares,
+CherryPy tools are similar in spirit.
+They add functions that are applied during the
+request/response processing.
+
+.. _hookpoint:
+
+Hook point
+^^^^^^^^^^
+
+A hook point is a point during the request/response processing.
+
+Here is a quick rundown of the "hook points" that you can hang your tools on:
+
+ * **"on_start_resource"** - The earliest hook; the Request-Line and request headers
+ have been processed and a dispatcher has set request.handler and request.config.
+ * **"before_request_body"** - Tools that are hooked up here run right before the
+ request body would be processed.
+ * **"before_handler"** - Right before the request.handler (the :term:`exposed` callable
+ that was found by the dispatcher) is called.
+ * **"before_finalize"** - This hook is called right after the page handler has been
+ processed and before CherryPy formats the final response object. It helps
+ you for example to check for what could have been returned by your page
+ handler and change some headers if needed.
+ * **"on_end_resource"** - Processing is complete - the response is ready to be
+ returned. This doesn't always mean that the request.handler (the exposed
+ page handler) has executed! It may be a generator. If your tool absolutely
+ needs to run after the page handler has produced the response body, you
+ need to either use on_end_request instead, or wrap the response.body in a
+ generator which applies your tool as the response body is being generated.
+ * **"before_error_response"** - Called right before an error response
+ (status code, body) is set.
+ * **"after_error_response"** - Called right after the error response
+ (status code, body) is set and just before the error response is finalized.
+ * **"on_end_request"** - The request/response conversation is over, all data has
+ been written to the client, nothing more to see here, move along.
+
+.. _tools:
+
+Tools
+^^^^^
+
+A tool is a simple callable object (function, method, object
+implementing a `__call__` method) that is attached to a
+:ref:`hook point <hookpoint>`.
+
+Below is a simple tool that is attached to the `before_finalize`
+hook point, hence after the page handler was called:
+
+.. code-block:: python
+
+ def log_it():
+ print(cherrypy.request.remote.ip)
+
+ cherrypy.tools.logit = cherrypy.Tool('before_finalize', log_it)
+
+Using that tool is as simple as follows:
+
+.. code-block:: python
+
+ class Root(object):
+ @cherrypy.expose
+ @cherrypy.tools.logit()
+ def index(self):
+ return "hello world"
+
+Obviously the tool may be declared the
+:ref:`other usual ways <perappconf>`.
+
+.. note::
+
+ The name of the tool, technically the attribute set to `cherrypy.tools`,
+ does not have to match the name of the callable. However, it is
+ that name that will be used in the configuration to refer to that
+ tool.
+
+Stateful tools
+~~~~~~~~~~~~~~
+
+The tools mechanism is really flexible and enables
+rich per-request functionalities.
+
+Straight tools as shown in the previous section are
+usually good enough. However, if your workflow
+requires some sort of state during the request processing,
+you will probably want a class-based approach:
+
+.. code-block:: python
+
+ import time
+
+ import cherrypy
+
+ class TimingTool(cherrypy.Tool):
+ def __init__(self):
+ cherrypy.Tool.__init__(self, 'before_handler',
+ self.start_timer,
+ priority=95)
+
+ def _setup(self):
+ cherrypy.Tool._setup(self)
+ cherrypy.request.hooks.attach('before_finalize',
+ self.end_timer,
+ priority=5)
+
+ def start_timer(self):
+ cherrypy.request._time = time.time()
+
+ def end_timer(self):
+ duration = time.time() - cherrypy.request._time
+ cherrypy.log("Page handler took %.4f" % duration)
+
+ cherrypy.tools.timeit = TimingTool()
+
+This tool computes the time taken by the page handler
+for a given request. It stores the time at which the handler
+is about to get called and logs the time difference
+right after the handler returned its result.
+
+The import bits is that the :class:`cherrypy.Tool <cherrypy._cptools.Tool>` constructor
+allows you to register to a hook point but, to attach the
+same tool to a different hook point, you must use the
+:meth:`cherrypy.request.hooks.attach <cherrypy._cprequest.HookMap.attach>` method.
+The :meth:`cherrypy.Tool._setup <cherrypy._cptools.Tool._setup>`
+method is automatically called by CherryPy when the tool
+is applied to the request.
+
+Next, let's see how to use our tool:
+
+.. code-block:: python
+
+ class Root(object):
+ @cherrypy.expose
+ @cherrypy.tools.timeit()
+ def index(self):
+ return "hello world"
+
+Tools ordering
+~~~~~~~~~~~~~~
+
+Since you can register many tools at the same hookpoint,
+you may wonder in which order they will be applied.
+
+CherryPy offers a deterministic, yet so simple, mechanism
+to do so. Simply set the **priority** attribute to a value
+from 1 to 100, lower values providing greater priority.
+
+If you set the same priority for several tools, they will
+be called in the order you declare them in your configuration.
+
+Toolboxes
+~~~~~~~~~
+
+All of the builtin CherryPy tools are collected into a Toolbox called
+:attr:`cherrypy.tools`. It responds to config entries in the ``"tools"``
+:ref:`namespace<namespaces>`. You can add your own Tools to this Toolbox
+as described above.
+
+You can also make your own Toolboxes if you need more modularity. For example,
+you might create multiple Tools for working with JSON, or you might publish
+a set of Tools covering authentication and authorization from which everyone
+could benefit (hint, hint). Creating a new Toolbox is as simple as:
+
+.. code-block:: python
+
+ import cherrypy
+
+ # Create a new Toolbox.
+ newauthtools = cherrypy._cptools.Toolbox("newauth")
+
+ # Add a Tool to our new Toolbox.
+ def check_access(default=False):
+ if not getattr(cherrypy.request, "userid", default):
+ raise cherrypy.HTTPError(401)
+ newauthtools.check_access = cherrypy.Tool('before_request_body', check_access)
+
+Then, in your application, use it just like you would use ``cherrypy.tools``,
+with the additional step of registering your toolbox with your app.
+Note that doing so automatically registers the ``"newauth"`` config namespace;
+you can see the config entries in action below:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class Root(object):
+ @cherrypy.expose
+ def default(self):
+ return "Hello"
+
+ conf = {
+ '/demo': {
+ 'newauth.check_access.on': True,
+ 'newauth.check_access.default': True,
+ }
+ }
+
+ app = cherrypy.tree.mount(Root(), config=conf)
+
+Request parameters manipulation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+HTTP uses strings to carry data between two endpoints.
+However your application may make better use of richer
+object types. As it wouldn't be really readable, nor
+a good idea regarding maintenance, to let each page handler
+deserialize data, it's a common pattern to delegate
+this functions to tools.
+
+For instance, let's assume you have a user id in the query-string
+and some user data stored into a database. You could
+retrieve the data, create an object and pass it on to the
+page handler instead of the user id.
+
+
+.. code-block:: python
+
+ import cherrypy
+
+ class UserManager(cherrypy.Tool):
+ def __init__(self):
+ cherrypy.Tool.__init__(self, 'before_handler',
+ self.load, priority=10)
+
+ def load(self):
+ req = cherrypy.request
+
+ # let's assume we have a db session
+ # attached to the request somehow
+ db = req.db
+
+ # retrieve the user id and remove it
+ # from the request parameters
+ user_id = req.params.pop('user_id')
+ req.params['user'] = db.get(int(user_id))
+
+ cherrypy.tools.user = UserManager()
+
+
+ class Root(object):
+ @cherrypy.expose
+ @cherrypy.tools.user()
+ def index(self, user):
+ return "hello %s" % user.name
+
+In other words, CherryPy give you the power to:
+
+- inject data, that wasn't part of the initial request, into the page handler
+- remove data as well
+- convert data into a different, more useful, object to remove that burden
+ from the page handler itself
+
+.. _dispatchers:
+
+Tailored dispatchers
+####################
+
+Dispatching is the art of locating the appropriate page handler
+for a given request. Usually, dispatching is based on the
+request's URL, the query-string and, sometimes, the request's method
+(GET, POST, etc.).
+
+Based on this, CherryPy comes with various dispatchers already.
+
+In some cases however, you will need a little more. Here is an example
+of dispatcher that will always ensure the incoming URL leads
+to a lower-case page handler.
+
+.. code-block:: python
+
+ import random
+ import string
+
+ import cherrypy
+ from cherrypy._cpdispatch import Dispatcher
+
+ class StringGenerator(object):
+ @cherrypy.expose
+ def generate(self, length=8):
+ return ''.join(random.sample(string.hexdigits, int(length)))
+
+ class ForceLowerDispatcher(Dispatcher):
+ def __call__(self, path_info):
+ return Dispatcher.__call__(self, path_info.lower())
+
+ if __name__ == '__main__':
+ conf = {
+ '/': {
+ 'request.dispatch': ForceLowerDispatcher(),
+ }
+ }
+ cherrypy.quickstart(StringGenerator(), '/', conf)
+
+Once you run this snipper, go to:
+
+- http://localhost:8080/generate?length=8
+- http://localhost:8080/GENerAte?length=8
+
+In both cases, you will be led to the `generate` page
+handler. Without our home-made dispatcher, the second
+one would fail and return a 404 error (:rfc:`2616#sec10.4.5`).
+
+Tool or dispatcher?
+^^^^^^^^^^^^^^^^^^^
+
+In the previous example, why not simply use a tool? Well, the sooner
+a tool can be called is always after the page handler has been found.
+In our example, it would be already too late as the default dispatcher
+would have not even found a match for `/GENerAte`.
+
+A dispatcher exists mostly to determine the best page
+handler to serve the requested resource.
+
+On ther other hand, tools are there to adapt the request's processing
+to the runtime context of the application and the request's content.
+
+Usually, you will have to write a dispatcher only if you
+have a very specific use case to locate the most adequate
+page handler. Otherwise, the default ones will likely suffice.
+
+Request body processors
+#######################
+
+Since its 3.2 release, CherryPy provides a really elegant
+and powerful mechanism to deal with a request's body based
+on its mimetype. Refer to the :mod:`cherrypy._cpreqbody` module
+to understand how to implement your own processors.
diff --git a/docs/glossary.rst b/docs/glossary.rst
new file mode 100644
index 00000000..cfeb0966
--- /dev/null
+++ b/docs/glossary.rst
@@ -0,0 +1,34 @@
+
+Glossary
+--------
+
+.. glossary::
+
+ application
+ A CherryPy application is simply a class instance containing
+ at least one page handler.
+
+ controller
+ Loose name commonly given to a class owning at least one exposed method
+
+ exposed
+ A Python function or method which has an attribute called `exposed`
+ set to `True`. This attribute can be set directly or via the
+ :func:`cherrypy.expose()` decorator.
+
+ .. code-block:: python
+
+ @cherrypy.expose
+ def method(...):
+ ...
+
+ is equivalent to:
+
+ .. code-block:: python
+
+ def method(...):
+ ...
+ method.exposed = True
+
+ page handler
+ Name commonly given to an exposed method
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..0ccc48aa
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,51 @@
+
+CherryPy - A Minimalist Python Web Framework
+============================================
+
+.. toctree::
+ :hidden:
+
+ intro.rst
+ install.rst
+ tutorials.rst
+ basics.rst
+ advanced.rst
+ config.rst
+ extend.rst
+ deploy.rst
+ contribute.rst
+ glossary.rst
+
+`CherryPy <http://www.cherrypy.org>`_ is a pythonic, object-oriented web framework.
+
+CherryPy allows developers to build web applications in much the
+same way they would build any other object-oriented Python program.
+This results in smaller source code developed in less time.
+
+CherryPy is now more than ten years old and it is has proven to
+be fast and reliable. It is being used in production by many
+sites, from the simplest to the most demanding.
+
+A CherryPy application typically looks like this:
+
+.. code-block:: python
+
+ import cherrypy
+
+ class HelloWorld(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello World!"
+
+ cherrypy.quickstart(HelloWorld())
+
+In order to make the most of CherryPy, you should start
+with the :ref:`tutorials <tutorials>` that will lead you through the most common
+aspects of the framework. Once done, you will probably want to
+browse through the :ref:`basics <basics>` and :ref:`advanced <advanced>`
+sections that will demonstrate how to implement certain operations.
+Finally, you will want to carefully read the configuration and
+:ref:`extend <extend>` sections that go in-depth regarding the
+powerful features provided by the framework.
+
+Above all, have fun with your application!
diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644
index 00000000..68dd9692
--- /dev/null
+++ b/docs/install.rst
@@ -0,0 +1,156 @@
+
+Installation
+------------
+
+CherryPy is a pure Python library. This has various consequences:
+
+ - It can run anywhere Python runs
+ - It does not require a C compiler
+ - It can run on various implementations of the Python language: `CPython <http://python.org/>`_,
+ `IronPython <http://ironpython.net/>`_, `Jython <http://www.jython.org/>`_ and `PyPy <http://pypy.org/>`_
+
+.. contents::
+ :depth: 4
+
+Requirements
+############
+
+CherryPy does not have any mandatory requirements. However certain features it comes with
+will require you install certain packages.
+
+- `routes <http://routes.readthedocs.org/en/latest/>`_ for declarative URL mapping dispatcher
+- `psycopg2 <http://pythonhosted.org//psycopg2/>`_ for PostgreSQL backend session
+- `pywin32 <http://sourceforge.net/projects/pywin32/>`_ for Windows services
+- `python-memcached <https://github.com/linsomniac/python-memcached>`_ for memcached backend session
+- `simplejson <https://github.com/simplejson/simplejson>`_ for a better JSON support
+- `pyOpenSSL <https://github.com/pyca/pyopenssl>`_ if your Python environment does not have the builtin :mod:`ssl` module
+
+Supported python version
+########################
+
+CherryPy supports Python 2.3 through to 3.4.
+
+
+Installing
+##########
+
+CherryPy can be easily installed via common Python package managers such as setuptools or pip.
+
+.. code-block:: bash
+
+ $ easy_install cherrypy
+
+
+.. code-block:: bash
+
+ $ pip install cherrypy
+
+You may also get the latest CherryPy version by grabbing the source code from BitBucket:
+
+.. code-block:: bash
+
+ $ hg clone https://bitbucket.org/cherrypy/cherrypy
+ $ cd cherrypy
+ $ python setup.py install
+
+Test your installation
+^^^^^^^^^^^^^^^^^^^^^^
+
+CherryPy comes with a set of simple tutorials that can be executed
+once you have deployed the package.
+
+.. code-block:: bash
+
+ $ python -m cherrypy.tutorial.tut01_helloworld
+
+Point your browser at http://127.0.0.1:8080 and enjoy the magic.
+
+Once started the above command shows the following logs:
+
+.. code-block:: bash
+
+ [15/Feb/2014:21:51:22] ENGINE Listening for SIGHUP.
+ [15/Feb/2014:21:51:22] ENGINE Listening for SIGTERM.
+ [15/Feb/2014:21:51:22] ENGINE Listening for SIGUSR1.
+ [15/Feb/2014:21:51:22] ENGINE Bus STARTING
+ [15/Feb/2014:21:51:22] ENGINE Started monitor thread 'Autoreloader'.
+ [15/Feb/2014:21:51:22] ENGINE Started monitor thread '_TimeoutMonitor'.
+ [15/Feb/2014:21:51:22] ENGINE Serving on http://127.0.0.1:8080
+ [15/Feb/2014:21:51:23] ENGINE Bus STARTED
+
+We will explain what all those lines mean later on, but suffice
+to know that once you see the last two lines, your server
+is listening and ready to receive requests.
+
+Run it
+######
+
+During development, the easiest path is to run your application as
+follow:
+
+.. code-block:: bash
+
+ $ python myapp.py
+
+As long as `myapp.py` defines a `"__main__"` section, it will
+run just fine.
+
+cherryd
+^^^^^^^
+
+Another way to run the application is through the ``cherryd`` script
+which is installed along side CherryPy.
+
+.. note::
+
+ This utility command will not concern you if you embed your
+ application with another framework.
+
+Command-Line Options
+~~~~~~~~~~~~~~~~~~~~
+
+.. program:: cherryd
+
+.. cmdoption:: -c, --config
+
+ Specify config file(s)
+
+.. cmdoption:: -d
+
+ Run the server as a daemon
+
+.. cmdoption:: -e, --environment
+
+ Apply the given config environment (defaults to None)
+
+
+.. index:: FastCGI
+
+.. cmdoption:: -f
+
+ Start a :ref:`FastCGI <fastcgi>` server instead of the default HTTP server
+
+
+.. index:: SCGI
+
+.. cmdoption:: -s
+
+ Start a SCGI server instead of the default HTTP server
+
+
+.. cmdoption:: -i, --import
+
+ Specify modules to import
+
+
+.. index:: PID file
+
+.. cmdoption:: -p, --pidfile
+
+ Store the process id in the given file (defaults to None)
+
+
+.. cmdoption:: -P, --Path
+
+ Add the given paths to sys.path
+
diff --git a/docs/intro.rst b/docs/intro.rst
new file mode 100644
index 00000000..72af26d3
--- /dev/null
+++ b/docs/intro.rst
@@ -0,0 +1,150 @@
+Foreword
+--------
+
+Why CherryPy?
+#############
+
+CherryPy is among the oldest web framework available for Python, yet many people aren't aware of its existence.
+One of the reason for this is that CherryPy is not a complete stack with built-in support for a multi-tier architecture.
+It doesn't provide frontend utilities nor will it tell you how to speak with your storage. Instead, CherryPy's take
+is to let the developer make those decisions. This is a contrasting position compared to other well-known frameworks.
+
+CherryPy has a clean interface and does its best to stay out of your way whilst providing
+a reliable scaffolding for you to build from.
+
+Typical use-cases for CherryPy go from regular web application with user frontends
+(think blogging, CMS, portals, ecommerce) to web-services only.
+
+Here are some reasons you would want to choose CherryPy:
+
+1. Simplicity
+
+ Developing with CherryPy is a simple task. “Hello, world” is only a few lines long, and does not require the developer to learn the entire (albeit very manageable) framework all at once. The framework is very pythonic; that is, it follows Python’s conventions very nicely (code is sparse and clean).
+
+ Contrast this with J2EE and Python’s most popular and visible web frameworks: Django, Zope, Pylons, and Turbogears. In all of them, the learning curve is massive. In these frameworks, “Hello, world” requires the programmer to set up a large scaffold which spans multiple files and to type a lot of boilerplate code. CherryPy succeeds because it does not include the bloat of other frameworks, allowing the programmer to write their web application quickly while still maintaining a high level of organization and scalability.
+
+ CherryPy is also very modular. The core is fast and clean, and extension features are easy to write and plug in using code or the elegant config system. The primary components (server, engine, request, response, etc.) are all extendable (even replaceable) and well-managed.
+
+ In short, CherryPy empowers the developer to work with the framework, not against or around it.
+
+2. Power
+
+ CherryPy leverages all of the power of Python. Python is a dynamic language which allows for rapid development of applications. Python also has an extensive built-in API which simplifies web app development. Even more extensive, however, are the third-party libraries available for Python. These range from object-relational mappers to form libraries, to an automatic Python optimizer, a Windows exe generator, imaging libraries, email support, HTML templating engines, etc. CherryPy applications are just like regular Python applications. CherryPy does not stand in your way if you want to use these brilliant tools.
+
+ CherryPy also provides :ref:`tools <tools>` and :ref:`plugins <busplugins>`, which are powerful extension points needed to develop world-class web applications.
+
+3. Maturity
+
+ Maturity is extremely important when developing a real-world application. Unlike many other web frameworks, CherryPy has had many final, stable releases. It is fully bugtested, optimized, and proven reliable for real-world use. The API will not suddenly change and break backwards compatibility, so your applications are assured to continue working even through subsequent updates in the current version series.
+
+ CherryPy is also a “3.0” project: the first edition of CherryPy set the tone, the second edition made it work, and the third edition makes it beautiful. Each version built on lessons learned from the previous, bringing the developer a superior tool for the job.
+
+4. Community
+
+ CherryPy has an devoted community that develops deployed CherryPy applications and are willing and ready to assist you on the CherryPy mailing list or IRC (#cherrypy on OFTC). The developers also frequent the list and often answer questions and implement features requested by the end-users.
+
+5. Deployability
+
+ Unlike many other Python web frameworks, there are cost-effective ways to deploy your CherryPy application.
+
+ Out of the box, CherryPy includes its own production-ready HTTP server to host your application. CherryPy can also be deployed on any WSGI-compliant gateway (a technology for interfacing numerous types of web servers): mod_wsgi, FastCGI, SCGI, IIS, uwsgi, tornado, etc. Reverse proxying is also a common and easy way to set it up.
+
+ In addition, CherryPy is pure-python and is compatible with Python 2.3. This means that CherryPy will run on all major platforms that Python will run on (Windows, MacOSX, Linux, BSD, etc).
+
+ `webfaction.com <https://www.webfaction.com>`_, run by the inventor of CherryPy, is a commercial web host that offers CherryPy hosting packages (in addition to several others).
+
+6. It’s free!
+
+ All of CherryPy is licensed under the open-source BSD license, which means CherryPy can be used commercially for ZERO cost.
+
+7. Where to go from here?
+
+ Check out the :ref:`tutorials <tutorials>` to start enjoying the fun!
+
+.. _successstories:
+
+Success Stories
+###############
+
+You are interested in CherryPy but you would like to hear more from people
+using it, or simply check out products or application running it.
+
+If you would like to have your CherryPy powered website or product listed here,
+contact us via our `mailing list <http://groups.google.com/group/cherrypy-users>`_
+or IRC (#cherrypy on `OFTC <http://www.oftc.net/oftc/>`_).
+
+
+Websites running atop CherryPy
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`Hulu Deejay and Hulu Sod <http://tech.hulu.com/blog/2013/03/13/python-and-hulu>`_ - Hulu uses
+CherryPy for some projects.
+"The service needs to be very high performance.
+Python, together with CherryPy,
+`gunicorn <http://gunicorn.org>`_, and gevent more than provides for this."
+
+`Netflix <http://techblog.netflix.com/2013/03/python-at-netflix.html>`_ - Netflix uses CherryPy as a building block in their infrastructure: "Restful APIs to
+large applications with requests, providing web interfaces with CherryPy and Bottle,
+and crunching data with scipy."
+
+`Urbanility <http://urbanility.com>`_ - French website for local neighbourhood assets in Rennes, France.
+
+`MROP Supply <https://www.mropsupply.com>`_ - Webshop for industrial equipment,
+developed using CherryPy 3.2.2 utilizing Python 3.2,
+with libs: `Jinja2-2.6 <http://jinja.pocoo.org/docs>`_, davispuh-MySQL-for-Python-3-3403794,
+pyenchant-1.6.5 (for search spelling).
+"I'm coming over from .net development and found Python and CherryPy to
+be surprisingly minimalistic. No unnecessary overhead - build everything you
+need without the extra fluff. I'm a fan!"
+
+`CherryMusic <http://www.fomori.org/cherrymusic>`_ - A music streaming server written in python:
+Stream your own music collection to all your devices! CherryMusic is open source.
+
+`YouGov Global <http://www.yougov.com>`_ - International market research firm, conducts
+millions of surveys on CherryPy yearly.
+
+`Aculab Cloud <http://cloud.aculab.com>`_ - Voice and fax applications on the cloud.
+A simple telephony API for Python, C#, C++, VB, etc...
+The website and all front-end and back-end web services are built with CherryPy,
+fronted by nginx (just handling the ssh and reverse-proxy), and running on AWS in two regions.
+
+`Learnit Training <http://www.learnit.nl>`_ - Dutch website for an IT, Management and
+Communication training company. Built on CherryPy 3.2.0 and Python 2.7.3, with
+`oursql <http://pythonhosted.org/oursql>`_ and
+`DBUtils <http://www.webwareforpython.org/DBUtils>`_ libraries, amongst others.
+
+`Linstic <http://linstic.com>`_ - Sticky Notes in your browser (with linking).
+
+`Almad's Homepage <http://www.almad.net>`_ - Simple homepage with blog.
+
+`Fight.Watch <http://fight.watch>`_ - Twitch.tv web portal for fighting games.
+Built on CherryPy 3.3.0 and Python 2.7.3 with Jinja 2.7.2 and SQLAlchemy 0.9.4.
+
+Products based on CherryPy
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`SABnzbd <http://sabnzbd.org>`_ - Open Source Binary Newsreader written in Python.
+
+`Headphones <https://github.com/rembo10/headphones>`_ - Third-party add-on for SABnzbd.
+
+`SickBeard <http://sickbeard.com>`_ - "Sick Beard is a PVR for newsgroup users (with limited torrent support). It watches for new episodes of your favorite shows and when they are posted it downloads them, sorts and renames them, and optionally generates metadata for them."
+
+`TurboGears <http://www.turbogears.org>`_ - The rapid web development megaframework. Turbogears 1.x used Cherrypy. "CherryPy is the underlying application server for TurboGears. It is responsible for taking the requests from the user’s browser, parses them and turns them into calls into the Python code of the web application. Its role is similar to application servers used in other programming languages".
+
+`Indigo <http://www.perceptiveautomation.com/indigo/index.html>`_ - "An intelligent home control
+server that integrates home control hardware modules to provide control of your home. Indigo's built-in
+Web server and client/server architecture give you control and access to your home remotely from
+other Macs, PCs, internet tablets, PDAs, and mobile phones."
+
+`SlikiWiki <http://www.sf.net/projects/slikiwiki>`_ - Wiki built on CherryPy and featuring WikiWords, automatic backlinking, site map generation, full text search, locking for concurrent edits, RSS feed embedding, per page access control lists, and page formatting using PyTextile markup."
+
+`read4me <http://sourceforge.net/projects/read4me>`_ - read4me is a Python feed-reading web service.
+
+`Firebird QA tools <http://www.firebirdsql.org/en/quality-assurance>`_ - Firebird QA tools are based on CherryPy.
+
+`salt-api <https://github.com/saltstack/salt-api>`_ - A REST API for Salt, the infrastructure orchestration tool.
+
+Products inspired by CherryPy
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`OOWeb <http://ooweb.sourceforge.net/>`_ - "OOWeb is a lightweight, embedded HTTP server for Java applications that maps objects to URL directories, methods to pages and form/querystring arguments as method parameters. OOWeb was originally inspired by CherryPy."
diff --git a/docs/pkg/cherrypy.lib.rst b/docs/pkg/cherrypy.lib.rst
new file mode 100644
index 00000000..b43db26a
--- /dev/null
+++ b/docs/pkg/cherrypy.lib.rst
@@ -0,0 +1,166 @@
+cherrypy.lib package
+====================
+
+Submodules
+----------
+
+cherrypy.lib.auth module
+------------------------
+
+.. automodule:: cherrypy.lib.auth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.auth_basic module
+------------------------------
+
+.. automodule:: cherrypy.lib.auth_basic
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.auth_digest module
+-------------------------------
+
+.. automodule:: cherrypy.lib.auth_digest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.caching module
+---------------------------
+
+.. automodule:: cherrypy.lib.caching
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.covercp module
+---------------------------
+
+.. automodule:: cherrypy.lib.covercp
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.cpstats module
+---------------------------
+
+.. automodule:: cherrypy.lib.cpstats
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.cptools module
+---------------------------
+
+.. automodule:: cherrypy.lib.cptools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.encoding module
+----------------------------
+
+.. automodule:: cherrypy.lib.encoding
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.gctools module
+---------------------------
+
+.. automodule:: cherrypy.lib.gctools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.http module
+------------------------
+
+.. automodule:: cherrypy.lib.http
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.httpauth module
+----------------------------
+
+.. automodule:: cherrypy.lib.httpauth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.httputil module
+----------------------------
+
+.. automodule:: cherrypy.lib.httputil
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.jsontools module
+-----------------------------
+
+.. automodule:: cherrypy.lib.jsontools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.lockfile module
+----------------------------
+
+.. automodule:: cherrypy.lib.lockfile
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.profiler module
+----------------------------
+
+.. automodule:: cherrypy.lib.profiler
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.reprconf module
+----------------------------
+
+.. automodule:: cherrypy.lib.reprconf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.sessions module
+----------------------------
+
+.. automodule:: cherrypy.lib.sessions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.static module
+--------------------------
+
+.. automodule:: cherrypy.lib.static
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.lib.xmlrpcutil module
+------------------------------
+
+.. automodule:: cherrypy.lib.xmlrpcutil
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cherrypy.lib
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/pkg/cherrypy.process.rst b/docs/pkg/cherrypy.process.rst
new file mode 100644
index 00000000..86fa5436
--- /dev/null
+++ b/docs/pkg/cherrypy.process.rst
@@ -0,0 +1,46 @@
+cherrypy.process package
+========================
+
+Submodules
+----------
+
+cherrypy.process.plugins module
+-------------------------------
+
+.. automodule:: cherrypy.process.plugins
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.process.servers module
+-------------------------------
+
+.. automodule:: cherrypy.process.servers
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.process.win32 module
+-----------------------------
+
+.. automodule:: cherrypy.process.win32
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.process.wspbus module
+------------------------------
+
+.. automodule:: cherrypy.process.wspbus
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cherrypy.process
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/pkg/cherrypy.rst b/docs/pkg/cherrypy.rst
new file mode 100644
index 00000000..e9287331
--- /dev/null
+++ b/docs/pkg/cherrypy.rst
@@ -0,0 +1,162 @@
+cherrypy package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+
+ cherrypy.lib
+ cherrypy.process
+ cherrypy.scaffold
+ cherrypy.test
+ cherrypy.tutorial
+ cherrypy.wsgiserver
+
+Submodules
+----------
+
+cherrypy._cpchecker module
+--------------------------
+
+.. automodule:: cherrypy._cpchecker
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpcompat module
+-------------------------
+
+.. automodule:: cherrypy._cpcompat
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpcompat_subprocess module
+------------------------------------
+
+.. automodule:: cherrypy._cpcompat_subprocess
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpconfig module
+-------------------------
+
+.. automodule:: cherrypy._cpconfig
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpdispatch module
+---------------------------
+
+.. automodule:: cherrypy._cpdispatch
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cperror module
+------------------------
+
+.. automodule:: cherrypy._cperror
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cplogging module
+--------------------------
+
+.. automodule:: cherrypy._cplogging
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpmodpy module
+------------------------
+
+.. automodule:: cherrypy._cpmodpy
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpnative_server module
+--------------------------------
+
+.. automodule:: cherrypy._cpnative_server
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpreqbody module
+--------------------------
+
+.. automodule:: cherrypy._cpreqbody
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cprequest module
+--------------------------
+
+.. automodule:: cherrypy._cprequest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpserver module
+-------------------------
+
+.. automodule:: cherrypy._cpserver
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpthreadinglocal module
+---------------------------------
+
+.. automodule:: cherrypy._cpthreadinglocal
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cptools module
+------------------------
+
+.. automodule:: cherrypy._cptools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cptree module
+-----------------------
+
+.. automodule:: cherrypy._cptree
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpwsgi module
+-----------------------
+
+.. automodule:: cherrypy._cpwsgi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy._cpwsgi_server module
+------------------------------
+
+.. automodule:: cherrypy._cpwsgi_server
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cherrypy
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/pkg/cherrypy.scaffold.rst b/docs/pkg/cherrypy.scaffold.rst
new file mode 100644
index 00000000..c13adbf0
--- /dev/null
+++ b/docs/pkg/cherrypy.scaffold.rst
@@ -0,0 +1,10 @@
+cherrypy.scaffold package
+=========================
+
+Module contents
+---------------
+
+.. automodule:: cherrypy.scaffold
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/pkg/cherrypy.test.rst b/docs/pkg/cherrypy.test.rst
new file mode 100644
index 00000000..88f1d68a
--- /dev/null
+++ b/docs/pkg/cherrypy.test.rst
@@ -0,0 +1,390 @@
+cherrypy.test package
+=====================
+
+Submodules
+----------
+
+cherrypy.test._test_decorators module
+-------------------------------------
+
+.. automodule:: cherrypy.test._test_decorators
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test._test_states_demo module
+--------------------------------------
+
+.. automodule:: cherrypy.test._test_states_demo
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.benchmark module
+------------------------------
+
+.. automodule:: cherrypy.test.benchmark
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.checkerdemo module
+--------------------------------
+
+.. automodule:: cherrypy.test.checkerdemo
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.helper module
+---------------------------
+
+.. automodule:: cherrypy.test.helper
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.logtest module
+----------------------------
+
+.. automodule:: cherrypy.test.logtest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.modfastcgi module
+-------------------------------
+
+.. automodule:: cherrypy.test.modfastcgi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.modfcgid module
+-----------------------------
+
+.. automodule:: cherrypy.test.modfcgid
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.modpy module
+--------------------------
+
+.. automodule:: cherrypy.test.modpy
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.modwsgi module
+----------------------------
+
+.. automodule:: cherrypy.test.modwsgi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.sessiondemo module
+--------------------------------
+
+.. automodule:: cherrypy.test.sessiondemo
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_auth_basic module
+------------------------------------
+
+.. automodule:: cherrypy.test.test_auth_basic
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_auth_digest module
+-------------------------------------
+
+.. automodule:: cherrypy.test.test_auth_digest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_bus module
+-----------------------------
+
+.. automodule:: cherrypy.test.test_bus
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_caching module
+---------------------------------
+
+.. automodule:: cherrypy.test.test_caching
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_compat module
+--------------------------------
+
+.. automodule:: cherrypy.test.test_compat
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_config module
+--------------------------------
+
+.. automodule:: cherrypy.test.test_config
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_config_server module
+---------------------------------------
+
+.. automodule:: cherrypy.test.test_config_server
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_conn module
+------------------------------
+
+.. automodule:: cherrypy.test.test_conn
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_core module
+------------------------------
+
+.. automodule:: cherrypy.test.test_core
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_dynamicobjectmapping module
+----------------------------------------------
+
+.. automodule:: cherrypy.test.test_dynamicobjectmapping
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_encoding module
+----------------------------------
+
+.. automodule:: cherrypy.test.test_encoding
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_etags module
+-------------------------------
+
+.. automodule:: cherrypy.test.test_etags
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_http module
+------------------------------
+
+.. automodule:: cherrypy.test.test_http
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_httpauth module
+----------------------------------
+
+.. automodule:: cherrypy.test.test_httpauth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_httplib module
+---------------------------------
+
+.. automodule:: cherrypy.test.test_httplib
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_json module
+------------------------------
+
+.. automodule:: cherrypy.test.test_json
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_logging module
+---------------------------------
+
+.. automodule:: cherrypy.test.test_logging
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_mime module
+------------------------------
+
+.. automodule:: cherrypy.test.test_mime
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_misc_tools module
+------------------------------------
+
+.. automodule:: cherrypy.test.test_misc_tools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_objectmapping module
+---------------------------------------
+
+.. automodule:: cherrypy.test.test_objectmapping
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_proxy module
+-------------------------------
+
+.. automodule:: cherrypy.test.test_proxy
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_refleaks module
+----------------------------------
+
+.. automodule:: cherrypy.test.test_refleaks
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_request_obj module
+-------------------------------------
+
+.. automodule:: cherrypy.test.test_request_obj
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_routes module
+--------------------------------
+
+.. automodule:: cherrypy.test.test_routes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_session module
+---------------------------------
+
+.. automodule:: cherrypy.test.test_session
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_sessionauthenticate module
+---------------------------------------------
+
+.. automodule:: cherrypy.test.test_sessionauthenticate
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_states module
+--------------------------------
+
+.. automodule:: cherrypy.test.test_states
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_static module
+--------------------------------
+
+.. automodule:: cherrypy.test.test_static
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_tools module
+-------------------------------
+
+.. automodule:: cherrypy.test.test_tools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_tutorials module
+-----------------------------------
+
+.. automodule:: cherrypy.test.test_tutorials
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_virtualhost module
+-------------------------------------
+
+.. automodule:: cherrypy.test.test_virtualhost
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_wsgi_ns module
+---------------------------------
+
+.. automodule:: cherrypy.test.test_wsgi_ns
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_wsgi_vhost module
+------------------------------------
+
+.. automodule:: cherrypy.test.test_wsgi_vhost
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_wsgiapps module
+----------------------------------
+
+.. automodule:: cherrypy.test.test_wsgiapps
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.test_xmlrpc module
+--------------------------------
+
+.. automodule:: cherrypy.test.test_xmlrpc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.test.webtest module
+----------------------------
+
+.. automodule:: cherrypy.test.webtest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cherrypy.test
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/pkg/cherrypy.tutorial.rst b/docs/pkg/cherrypy.tutorial.rst
new file mode 100644
index 00000000..3676e0ba
--- /dev/null
+++ b/docs/pkg/cherrypy.tutorial.rst
@@ -0,0 +1,94 @@
+cherrypy.tutorial package
+=========================
+
+Submodules
+----------
+
+cherrypy.tutorial.tut01_helloworld module
+-----------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut01_helloworld
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut02_expose_methods module
+---------------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut02_expose_methods
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut03_get_and_post module
+-------------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut03_get_and_post
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut04_complex_site module
+-------------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut04_complex_site
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut05_derived_objects module
+----------------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut05_derived_objects
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut06_default_method module
+---------------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut06_default_method
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut07_sessions module
+---------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut07_sessions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut08_generators_and_yield module
+---------------------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut08_generators_and_yield
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut09_files module
+------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut09_files
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.tutorial.tut10_http_errors module
+------------------------------------------
+
+.. automodule:: cherrypy.tutorial.tut10_http_errors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cherrypy.tutorial
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/pkg/cherrypy.wsgiserver.rst b/docs/pkg/cherrypy.wsgiserver.rst
new file mode 100644
index 00000000..9e91f631
--- /dev/null
+++ b/docs/pkg/cherrypy.wsgiserver.rst
@@ -0,0 +1,46 @@
+cherrypy.wsgiserver package
+===========================
+
+Submodules
+----------
+
+cherrypy.wsgiserver.ssl_builtin module
+--------------------------------------
+
+.. automodule:: cherrypy.wsgiserver.ssl_builtin
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.wsgiserver.ssl_pyopenssl module
+----------------------------------------
+
+.. automodule:: cherrypy.wsgiserver.ssl_pyopenssl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.wsgiserver.wsgiserver2 module
+--------------------------------------
+
+.. automodule:: cherrypy.wsgiserver.wsgiserver2
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cherrypy.wsgiserver.wsgiserver3 module
+--------------------------------------
+
+.. automodule:: cherrypy.wsgiserver.wsgiserver3
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cherrypy.wsgiserver
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/pkg/modules.rst b/docs/pkg/modules.rst
new file mode 100644
index 00000000..fe45a992
--- /dev/null
+++ b/docs/pkg/modules.rst
@@ -0,0 +1,7 @@
+cherrypy
+========
+
+.. toctree::
+ :maxdepth: 4
+
+ cherrypy
diff --git a/docs/tutorials.rst b/docs/tutorials.rst
new file mode 100644
index 00000000..f919b318
--- /dev/null
+++ b/docs/tutorials.rst
@@ -0,0 +1,933 @@
+.. _tutorials:
+
+Tutorials
+---------
+
+
+This tutorial will walk you through basic but complete CherryPy applications
+that will show you common concepts as well as slightly more adavanced ones.
+
+.. contents::
+ :depth: 4
+
+Tutorial 1: A basic web application
+###################################
+
+The following example demonstrates the most basic application
+you could write with CherryPy. It starts a server and hosts
+an application that will be served at request reaching
+http://127.0.0.1:8080/
+
+.. code-block:: python
+ :linenos:
+
+ import cherrypy
+
+ class HelloWorld(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello world!"
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(HelloWorld())
+
+Store this code snippet into a file named `tut01.py` and
+execute it as follows:
+
+.. code-block:: bash
+
+ $ python tut01.py
+
+This will display something along the following:
+
+.. code-block:: text
+ :linenos:
+
+ [24/Feb/2014:21:01:46] ENGINE Listening for SIGHUP.
+ [24/Feb/2014:21:01:46] ENGINE Listening for SIGTERM.
+ [24/Feb/2014:21:01:46] ENGINE Listening for SIGUSR1.
+ [24/Feb/2014:21:01:46] ENGINE Bus STARTING
+ CherryPy Checker:
+ The Application mounted at '' has an empty config.
+
+ [24/Feb/2014:21:01:46] ENGINE Started monitor thread 'Autoreloader'.
+ [24/Feb/2014:21:01:46] ENGINE Started monitor thread '_TimeoutMonitor'.
+ [24/Feb/2014:21:01:46] ENGINE Serving on http://127.0.0.1:8080
+ [24/Feb/2014:21:01:46] ENGINE Bus STARTED
+
+This tells you several things. The first three lines indicate
+the server will handle :mod:`signal` for you. The next line tells you
+the current state of the server, as that
+point it is in `STARTING` stage. Then, you are notified your
+application has no specific configuration set to it.
+Next, the server starts a couple of internal utilities that
+we will explain later. Finally, the server indicates it is now
+ready to accept incoming communications as it listens on
+the address `127.0.0.1:8080`. In other words, at that stage your
+application is ready to be used.
+
+Before moving on, let's discuss the message
+regarding the lack of configuration. By default, CherryPy has
+a feature which will review the syntax correctness of settings
+you could provide to configure the application. When none are
+provided, a warning message is thus displayed in the logs. That
+log is harmless and will not prevent CherryPy from working. You
+can refer to :ref:`the documentation above <perappconf>` to
+understand how to set the configuration.
+
+Tutorial 2: Different URLs lead to different functions
+######################################################
+
+Your applications will obviously handle more than a single URL.
+Let's imagine you have an application that generates a random
+string each time it is called:
+
+.. code-block:: python
+ :linenos:
+
+ import random
+ import string
+
+ import cherrypy
+
+ class StringGenerator(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello world!"
+
+ @cherrypy.expose
+ def generate(self):
+ return ''.join(random.sample(string.hexdigits, 8))
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(StringGenerator())
+
+Save this into a file named `tut02.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ python tut02.py
+
+Go now to http://localhost:8080/generate and your browser
+will display a random string.
+
+Let's take a minute to decompose what's happening here. This is the
+URL that you have typed into your browser: http://localhost:8080/generate
+
+This URL contains various parts:
+
+- `http://` which roughly indicates it's a URL using the HTTP protocol (see :rfc:`2616`).
+- `localhost:8080` is the server's address. It's made of a hostname and a port.
+- `/generate` which is the path segment of the URL. This is what CherryPy uses to
+ locate an :term:`exposed` function or method to respond.
+
+Here CherryPy uses the `index()` method to handle `/` and the
+`generate()` method to handle `/generate`
+
+.. _tut03:
+
+Tutorial 3: My URLs have parameters
+###################################
+
+In the previous tutorial, we have seen how to create an application
+that could generate a random string. Let's not assume you wish
+to indicate the length of that string dynamically.
+
+.. code-block:: python
+ :linenos:
+
+ import random
+ import string
+
+ import cherrypy
+
+ class StringGenerator(object):
+ @cherrypy.expose
+ def index(self):
+ return "Hello world!"
+
+ @cherrypy.expose
+ def generate(self, length=8):
+ return ''.join(random.sample(string.hexdigits, int(length)))
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(StringGenerator())
+
+Save this into a file named `tut03.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ python tut03.py
+
+Go now to http://localhost:8080/generate?length=16 and your browser
+will display a generated string of length 16. Notice how
+we benefit from Python's default arguments' values to support
+URLs such as http://localhost:8080/password still.
+
+In a URL such as this one, the section after `?` is called a
+query-string. Traditionally, the query-string is used to
+contextualize the URL by passing a set of (key, value) pairs. The
+format for those pairs is `key=value`. Each pair being
+separated by a `&` character.
+
+Notice how we have to convert the given `length` value to
+and integer. Indeed, values are sent out from the client
+to our server as strings.
+
+Much like CherryPy maps URL path segments to exposed functions,
+query-string keys are mapped to those exposed function parameters.
+
+.. _tut04:
+
+Tutorial 4: Submit this form
+############################
+
+CherryPy is a web framework upon which you build web applications.
+The most traditionnal shape taken by applications is through
+an HTML user-interface speaking to your CherryPy server.
+
+Let's see how to handle HTML forms via the following
+example.
+
+.. code-block:: python
+ :linenos:
+
+ import random
+ import string
+
+ import cherrypy
+
+ class StringGenerator(object):
+ @cherrypy.expose
+ def index(self):
+ return """<html>
+ <head></head>
+ <body>
+ <form method="get" action="generate">
+ <input type="text" value="8" name="length" />
+ <button type="submit">Give it now!</button>
+ </form>
+ </body>
+ </html>"""
+
+ @cherrypy.expose
+ def generate(self, length=8):
+ return ''.join(random.sample(string.hexdigits, int(length)))
+
+ if __name__ == '__main__':
+ cherrypy.quickstart(StringGenerator())
+
+Save this into a file named `tut04.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ python tut04.py
+
+Go now to http://localhost:8080/ and your browser and this will
+display a simple input field to indicate the length of the string
+you want to generate.
+
+Notice that in this example, the form uses the `GET` method and
+when you pressed the `Give it now!` button, the form is sent using the
+same URL as in the :ref:`previous <tut03>` tutorial. HTML forms also support the
+`POST` method, in that case the query-string is not appended to the
+URL but it sent as the body of the client's request to the server.
+However, this would not change your application's exposed method because
+CherryPy handles both the same way and uses the exposed's handler
+parameters to deal with the query-string (key, value) pairs.
+
+.. _tut05:
+
+Tutorial 5: Track my end-user's activity
+########################################
+
+It's not uncommon that an application needs to follow the
+user's activity for a while. The usual mechanism is to use
+a `session identifier <http://en.wikipedia.org/wiki/Session_(computer_science)#HTTP_session_token>`_
+that is carried during the conversation between the user and
+your application.
+
+.. code-block:: python
+ :linenos:
+
+ import random
+ import string
+
+ import cherrypy
+
+ class StringGenerator(object):
+ @cherrypy.expose
+ def index(self):
+ return """<html>
+ <head></head>
+ <body>
+ <form method="get" action="generate">
+ <input type="text" value="8" name="length" />
+ <button type="submit">Give it now!</button>
+ </form>
+ </body>
+ </html>"""
+
+ @cherrypy.expose
+ def generate(self, length=8):
+ some_string = ''.join(random.sample(string.hexdigits, int(length)))
+ cherrypy.session['mystring'] = some_string
+ return some_string
+
+ @cherrypy.expose
+ def display(self):
+ return cherrypy.session['mystring']
+
+ if __name__ == '__main__':
+ conf = {
+ '/': {
+ 'tools.sessions.on': True
+ }
+ }
+ cherrypy.quickstart(StringGenerator(), '/', conf)
+
+Save this into a file named `tut05.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ python tut05.py
+
+In this example, we generate the string as in the
+:ref:`previous <tut04>` tutorial but also store it in the current
+session. If you go to http://localhostt:8080/, generate a
+random string, then go to http://localhostt:8080/display, you
+will see the string you just generated.
+
+The lines 30-34 show you how to enable the session support
+in your CherryPy application. By default, CherryPy will save
+sessions in the process's memory. It supports more persistent
+:ref:`backends <basicsession>` as well.
+
+Tutorial 6: What about my javascripts, CSS and images?
+######################################################
+
+Web application are usually also made of static content such
+as javascript, CSS files or images. CherryPy provides support
+to serve static content to end-users.
+
+Let's assume, you want to associate a stylesheet with your
+application to display a blue background color (why not?).
+
+First, save the following stylesheet into a file named `style.css`
+and stored into a local directory `public/css`.
+
+.. code-block:: css
+ :linenos:
+
+ body {
+ background-color: blue;
+ }
+
+Now let's update the HTML code so that we link to the stylesheet
+using the http://localhost:8080/static/css/style.css URL.
+
+.. code-block:: python
+ :linenos:
+
+ import os, os.path
+ import random
+ import string
+
+ import cherrypy
+
+ class StringGenerator(object):
+ @cherrypy.expose
+ def index(self):
+ return """<html>
+ <head>
+ <link href="/static/css/style.css" rel="stylesheet">
+ </head>
+ <body>
+ <form method="get" action="generate">
+ <input type="text" value="8" name="length" />
+ <button type="submit">Give it now!</button>
+ </form>
+ </body>
+ </html>"""
+
+ @cherrypy.expose
+ def generate(self, length=8):
+ some_string = ''.join(random.sample(string.hexdigits, int(length)))
+ cherrypy.session['mystring'] = some_string
+ return some_string
+
+ @cherrypy.expose
+ def display(self):
+ return cherrypy.session['mystring']
+
+ if __name__ == '__main__':
+ conf = {
+ '/': {
+ 'tools.sessions.on': True,
+ 'tools.staticdir.root': os.path.abspath(os.getcwd())
+ },
+ '/static': {
+ 'tools.staticdir.on': True,
+ 'tools.staticdir.dir': './public'
+ }
+ }
+ cherrypy.quickstart(StringGenerator(), '/', conf)
+
+Save this into a file named `tut06.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ python tut06.py
+
+Going to http://localhost:8080/, you should be greeted by a flashy blue color.
+
+CherryPy provides support to serve a single file or a complete
+directory structure. Most of the time, this is what you'll end
+up doing so this is what the code above demonstrates. First, we
+indicate the `root` directory of all of our static content. This
+must be an absolute path for security reason. CherryPy will
+complain if you provide only non-absolute paths when looking for a
+match to your URLs.
+
+Then we indicate that all URLs which path segment starts with `/static`
+will be served as static content. We map that URL to the `public`
+directory, a direct child of the `root` directory. The entire
+sub-tree of the `public` directory will be served as static content.
+CherryPy will map URLs to path within that directory. This is why
+`/static/css/style.css` is found in `public/css/style.css`.
+
+Tutorial 7: Give us a REST
+##########################
+
+It's not unusual nowadays that web applications expose some sort
+of datamodel or computation functions. Without going into
+its details, one strategy is to follow the `REST principles
+edicted by Roy T. Fielding
+<http://www.ibm.com/developerworks/library/ws-restful/index.html>`_.
+
+Roughly speaking, it assumes that you can identify a resource
+and that you can address that resource through that identifier.
+
+"What for?" you may ask. Well, mostly, these principles are there
+to ensure that you decouple, as best as you can, the entities
+your application expose from the way they are manipulated or
+consumed. To embrace this point of view, developers will
+usually design a web API that expose pairs of `(URL, HTTP method, data, constraints)`.
+
+.. note::
+
+ You will often hear REST and web API together. The former is
+ one strategy to provide the latter. This tutorial will not go
+ deeper in that whole web API concept as it's a much more
+ engaging subject, but you ought to read more about it online.
+
+
+Lets go through a small example of a very basic web API
+midly following REST principles.
+
+.. code-block:: python
+ :linenos:
+
+ import random
+ import string
+
+ import cherrypy
+
+ class StringGeneratorWebService(object):
+ exposed = True
+
+ @cherrypy.tools.accept(media='text/plain')
+ def GET(self):
+ return cherrypy.session['mystring']
+
+ def POST(self, length=8):
+ some_string = ''.join(random.sample(string.hexdigits, int(length)))
+ cherrypy.session['mystring'] = some_string
+ return some_string
+
+ def PUT(self, another_string):
+ cherrypy.session['mystring'] = another_string
+
+ def DELETE(self):
+ cherrypy.session.pop('mystring', None)
+
+ if __name__ == '__main__':
+ conf = {
+ '/': {
+ 'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
+ 'tools.sessions.on': True,
+ 'tools.response_headers.on': True,
+ 'tools.response_headers.headers': [('Content-Type', 'text/plain')],
+ }
+ }
+ cherrypy.quickstart(StringGeneratorWebService(), '/', conf)
+
+
+Save this into a file named `tut07.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ python tut07.py
+
+Before we see it in action, let's explain a few things. Until now,
+CherryPy was creating a tree of exposed methods that were used to
+math URLs. In the case of our web API, we want to stress the role
+played by the actual requests' HTTP methods. So we created
+methods that are named after them and they are all exposed at once
+through the `exposed = True` attribute of the class itself.
+
+However, we must then switch from the default mechanism of matching
+URLs to method for one that is aware of the whole HTTP method
+shenanigan. This is what goes on line 27 where we create
+a :class:`~cherrypy.dispatch.MethodDispatcher` instance.
+
+Then we force the responses `content-type` to be `text/plain` and
+we finally ensure that `GET` requests will only be responded to clients
+that accept that `content-type` by having a `Accept: text/plain`
+header set in their request. However, we do this only for that
+HTTP method as it wouldn't have much meaning on the oher methods.
+
+
+For the purpose of this tutorial, we will be using a Python client
+rather than your browser as we wouldn't be able to actually try
+our web API otherwiser.
+
+Please install `requests <http://www.python-requests.org/en/latest/>`_
+through the following command:
+
+.. code-block:: bash
+
+ $ pip install requests
+
+Then fire up a Python terminal and try the following commands:
+
+.. code-block:: pycon
+ :linenos:
+
+ >>> import requests
+ >>> s = requests.Session()
+ >>> r = s.get('http://127.0.0.1:8080/')
+ >>> r.status_code
+ 500
+ >>> r = s.post('http://127.0.0.1:8080/')
+ >>> r.status_code, r.text
+ (200, u'04A92138')
+ >>> r = s.get('http://127.0.0.1:8080/')
+ >>> r.status_code, r.text
+ (200, u'04A92138')
+ >>> r = s.get('http://127.0.0.1:8080/', headers={'Accept': 'application/json'})
+ >>> r.status_code
+ 406
+ >>> r = s.put('http://127.0.0.1:8080/', params={'another_string': 'hello'})
+ >>> r = s.get('http://127.0.0.1:8080/')
+ >>> r.status_code, r.text
+ (200, u'hello')
+ >>> r = s.delete('http://127.0.0.1:8080/')
+ >>> r = s.get('http://127.0.0.1:8080/')
+ >>> r.status_code
+ 500
+
+The first and last `500` responses steam from the fact that, in
+the first case, we haven't yet generated a string through `POST` and,
+on the latter case, that it doesn't exist after we've deleted it.
+
+Lines 12-14 show you how the application reacted when our client requested
+the generated string as a JSON format. Since we configured the
+web API to only support plain text, it returns the appropriate
+`HTTP error code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7`
+
+
+.. note::
+
+ We use the `Session <http://www.python-requests.org/en/latest/user/advanced/#session-objects>`_
+ interface of `requests` so that it takes care of carrying the
+ session id stored in the request cookie in each subsequent
+ request. That is handy.
+
+.. _tut08:
+
+
+Tutorial 8: Make it smoother with Ajax
+######################################
+
+In the recent years, web applications have moved away from the
+simple pattern of "HTML forms + refresh the whole page". This
+traditional scheme still works very well but users have become used
+to web applications that don't refresh the entire page.
+Broadly speaking, web applications carry code performed
+client-side that can speak with the backend without having to
+refresh the whole page.
+
+This tutorial will involve a little more code this time around. First,
+let's see our CSS stylesheet located in `public/css/style.css`.
+
+.. code-block:: css
+ :linenos:
+
+ body {
+ background-color: blue;
+ }
+
+ #the-string {
+ display: none;
+ }
+
+We're adding a simple rule about the element that will display
+the generated string. By default, let's not show it up.
+Save the following HTML code into a file named `index.html`.
+
+.. code-block:: html
+ :linenos:
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <link href="/static/css/style.css" rel="stylesheet">
+ <script src="http://code.jquery.com/jquery-2.0.3.min.js"></script>
+ <script type="text/javascript">
+ $(document).ready(function() {
+
+ $("#generate-string").click(function(e) {
+ $.post("/generator", {"length": $("input[name='length']").val()})
+ .done(function(string) {
+ $("#the-string").show();
+ $("#the-string input").val(string);
+ });
+ e.preventDefault();
+ });
+
+ $("#replace-string").click(function(e) {
+ $.ajax({
+ type: "PUT",
+ url: "/generator",
+ data: {"another_string": $("#the-string").val()}
+ })
+ .done(function() {
+ alert("Replaced!");
+ });
+ e.preventDefault();
+ });
+
+ $("#delete-string").click(function(e) {
+ $.ajax({
+ type: "DELETE",
+ url: "/generator"
+ })
+ .done(function() {
+ $("#the-string").hide();
+ });
+ e.preventDefault();
+ });
+
+ });
+ </script>
+ </head>
+ <body>
+ <input type="text" value="8" name="length" />
+ <button id="generate-string">Give it now!</button>
+ <div id="the-string">
+ <input type="text" />
+ <button id="replace-string">Replace</button>
+ <button id="delete-string">Delete it</button>
+ </div>
+ </body>
+ </html>
+
+We'll be using the `jQuery framework <http://jquery.com/>`_
+out of simplicity but feel free to replace it with your
+favourite tool. The page is composed of simple HTML elements
+to get user input and display the generated string. It also
+contains client-side code to talk to the backend API that
+actually performs the hard work.
+
+Finally, here's the application's code that serves the
+HTML page above and responds to requests to generate strings.
+Both are hosted by the same application server.
+
+.. code-block:: python
+ :linenos:
+
+ import os, os.path
+ import random
+ import string
+
+ import cherrypy
+
+ class StringGenerator(object):
+ @cherrypy.expose
+ def index(self):
+ return file('index.html')
+
+ class StringGeneratorWebService(object):
+ exposed = True
+
+ @cherrypy.tools.accept(media='text/plain')
+ def GET(self):
+ return cherrypy.session['mystring']
+
+ def POST(self, length=8):
+ some_string = ''.join(random.sample(string.hexdigits, int(length)))
+ cherrypy.session['mystring'] = some_string
+ return some_string
+
+ def PUT(self, another_string):
+ cherrypy.session['mystring'] = another_string
+
+ def DELETE(self):
+ cherrypy.session.pop('mystring', None)
+
+ if __name__ == '__main__':
+ conf = {
+ '/': {
+ 'tools.sessions.on': True,
+ 'tools.staticdir.root': os.path.abspath(os.getcwd())
+ },
+ '/generator': {
+ 'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
+ 'tools.response_headers.on': True,
+ 'tools.response_headers.headers': [('Content-Type', 'text/plain')],
+ },
+ '/static': {
+ 'tools.staticdir.on': True,
+ 'tools.staticdir.dir': './public'
+ }
+ }
+ webapp = StringGenerator()
+ webapp.generator = StringGeneratorWebService()
+ cherrypy.quickstart(webapp, '/', conf)
+
+
+Save this into a file named `tut08.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ python tut08.py
+
+Go to http://127.0.0.1:8080/ and play with the input and buttons
+to generate, replace or delete the strings. Notice how the page
+isn't refreshed, simply part of its content.
+
+Notice as well how your frontend converses with the backend using
+a straightfoward, yet clean, web service API. That same API
+could easily be used by non-HTML clients.
+
+
+Tutorial 9: Data is all my life
+###############################
+
+Until now, all the generated strings were saved in the
+session, which by default is stored in the process memory. Though,
+you can persist sessions on disk or in a distributed memory store,
+this is not the right way of keeping your data on the long run.
+Sessions are there to identify your user and carry as little
+amount of data as necessary for the operation carried by the user.
+
+To store, persist and query data your need a proper database server.
+There exist many to choose from with various paradigm support:
+
+- relational: PostgreSQL, SQLite, MariaDB, Firebird
+- column-oriented: HBase, Cassandra
+- key-store: redis, memcached
+- document oriented: Couchdb, MongoDB
+- graph-oriented: neo4j
+
+Let's focus on the relational ones since they are the most common
+and probably what you will want to learn first.
+
+For the sake of reducing the number of dependencies for these
+tutorials, we will go for the :mod:`sqlite` database which
+is directly supported by Python.
+
+Our application will replace the storage of the generated
+string from the session to a SQLite database. The application
+will have the same HTML code as :ref:`tutorial 08 <tut08>`.
+So let's simply focus on the application code itself:
+
+.. code-block:: python
+ :linenos:
+
+ import os, os.path
+ import random
+ import sqlite3
+ import string
+
+ import cherrypy
+
+ DB_STRING = "my.db"
+
+ class StringGenerator(object):
+ @cherrypy.expose
+ def index(self):
+ return file('index.html')
+
+ class StringGeneratorWebService(object):
+ exposed = True
+
+ @cherrypy.tools.accept(media='text/plain')
+ def GET(self):
+ with sqlite3.connect(DB_STRING) as c:
+ c.execute("SELECT value FROM user_string WHERE session_id=?",
+ [cherrypy.session.id])
+ return c.fetchone()
+
+ def POST(self, length=8):
+ some_string = ''.join(random.sample(string.hexdigits, int(length)))
+ with sqlite3.connect(DB_STRING) as c:
+ c.execute("INSERT INTO user_string VALUES (?, ?)",
+ [cherrypy.session.id, some_string])
+ return some_string
+
+ def PUT(self, another_string):
+ with sqlite3.connect(DB_STRING) as c:
+ c.execute("UPDATE user_string SET value=? WHERE session_id=?",
+ [another_string, cherrypy.session.id])
+
+ def DELETE(self):
+ with sqlite3.connect(DB_STRING) as c:
+ c.execute("DELETE FROM user_string WHERE session_id=?",
+ [cherrypy.session.id])
+
+ def setup_database():
+ """
+ Create the `user_string` table in the database
+ on server startup
+ """
+ with sqlite3.connect(DB_STRING) as con:
+ con.execute("CREATE TABLE user_string (session_id, value)")
+
+ def cleanup_database():
+ """
+ Destroy the `user_string` table from the database
+ on server shutdown.
+ """
+ with sqlite3.connect(DB_STRING) as con:
+ con.execute("DROP TABLE user_string")
+
+ if __name__ == '__main__':
+ conf = {
+ '/': {
+ 'tools.sessions.on': True,
+ 'tools.staticdir.root': os.path.abspath(os.getcwd())
+ },
+ '/generator': {
+ 'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
+ 'tools.response_headers.on': True,
+ 'tools.response_headers.headers': [('Content-Type', 'text/plain')],
+ },
+ '/static': {
+ 'tools.staticdir.on': True,
+ 'tools.staticdir.dir': './public'
+ }
+ }
+
+ cherrypy.engine.subscribe('start', setup_database)
+ cherrypy.engine.subscribe('stop', cleanup_database)
+
+ webapp = StringGenerator()
+ webapp.generator = StringGeneratorWebService()
+ cherrypy.quickstart(webapp, '/', conf)
+
+
+Save this into a file named `tut09.py` and run it as follows:
+
+.. code-block:: bash
+
+ $ python tut09.py
+
+Let's first see how we create two functions that create
+and destroy the table within our database. These functions
+are registered to the CherryPy's server on lines 76-77,
+so that they are called when the server starts and stops.
+
+Next, notice how we replaced all the session code with calls
+to the database. We use the session id to identify the
+user's string within our database. Since the session will go
+away after a while, it's probably not the right approach.
+A better idea would be to associate the user's login or
+more resilient unique identifier. For the sake of our
+demo, this should do.
+
+.. note::
+
+ Unfortunately, sqlite in Python forbids us
+ to share a connection between threads. Since CherryPy is a
+ multi-threaded server, this would be an issue. This is the
+ reason why we open and close a connection to the database
+ on each call. This is clearly not really production friendly,
+ and it is probably advisable to either use a more capable
+ database engine or a higher level library, such as
+ `SQLAlchemy <http://sqlalchemy.readthedocs.org>`_, to better
+ support your application's needs.
+
+
+Tutorial 10: Organize my code
+#############################
+
+CherryPy comes with a powerful architecture
+that helps you organizing your code in a way that should make
+it easier to maintain and more flexible.
+
+Several mechanisms are at your disposal, this tutorial will focus
+on the three main ones:
+
+- :ref:`dispatchers <dispatchers>`
+- :ref:`tools <tools>`
+- :ref:`plugins <busplugins>`
+
+In order to understand them, let's imagine you are at a superstore:
+
+- You have several tills and people queuing for each of them (those are your requests)
+- You have various sections with food and other stuff (these are your data)
+- Finally you have the superstore people and their daily tasks
+ to make sure sections are always in order (this is your backend)
+
+In spite of being really simplistic, this is not far from how your
+application behaves. CherryPy helps your structure your application
+in a way that mirrors these high-level ideas.
+
+Dispatchers
+^^^^^^^^^^^
+
+Coming back to the superstore example, it is likely that you will
+want to perform operations based on the till:
+
+- Have a till for baskets with less than ten items
+- Have a till for disabled people
+- Have a till for pregnant women
+- Have a till where you can only using the store card
+
+To support these use-cases, CherryPy provides a mechanism called
+a :ref:`dispatcher <dispatchers>`. A dispatcher is executed early
+during the request processing in order to determine which piece of
+code of your application will handle the incoming request. Or, to
+continue on the store analogy, a dispatcher will decide which
+till to lead a customer to.
+
+Tools
+^^^^^
+
+Let's assume your store has decided to operate a discount spree but,
+only for a specific category of customers. CherryPy will deal
+with such use case via a mechanism called a :ref:`tool <tools>`.
+
+A tool is a piece of code that runs on a per-request
+basis in order to perform additional work. Usually a tool is a
+simple Python function that is executed at a given point during
+the process of the request by CherryPy.
+
+Plugins
+^^^^^^^
+
+As we have seen, the store has a crew of people dedicated to manage
+the stock and deal with any customers' expectation.
+
+In the CherryPy world, this translates into having functions
+that run outside of any request life-cycle. These functions should
+take care of background tasks, long lived connections (such as
+those to a database for instance), etc.
+
+:ref:`Plugins <busplugins>` are called that way because
+they work along with the CherryPy :ref:`engine <cpengine>`
+and extend it with your operations.
+
+
diff --git a/sphinx/util/convert-trac.py b/docs/util/convert-trac.py
index ebb77d42..ebb77d42 100644
--- a/sphinx/util/convert-trac.py
+++ b/docs/util/convert-trac.py
diff --git a/sphinx/util/test-doc.py b/docs/util/test-doc.py
index 3d06da99..3d06da99 100644
--- a/sphinx/util/test-doc.py
+++ b/docs/util/test-doc.py
diff --git a/ez_setup.py b/ez_setup.py
deleted file mode 100644
index 28835dd1..00000000
--- a/ez_setup.py
+++ /dev/null
@@ -1,134 +0,0 @@
-#!python
-"""Bootstrap setuptools installation
-
-If you want to use setuptools in your package's setup.py, just include this
-file in the same directory with it, and add this to the top of your setup.py::
-
- from ez_setup import use_setuptools
- use_setuptools()
-
-If you want to require a specific version of setuptools, set a download
-mirror, or use an alternate download directory, you can do so by supplying
-the appropriate options to ``use_setuptools()``.
-
-This file can also be run as a script to install or upgrade setuptools.
-"""
-
-DEFAULT_VERSION = "0.5a13"
-DEFAULT_URL = "http://www.python.org/packages/source/s/setuptools/"
-
-import sys, os
-
-def use_setuptools(
- version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir
-):
- """Automatically find/download setuptools and make it available on sys.path
-
- `version` should be a valid setuptools version number that is available
- as an egg for download under the `download_base` URL (which should end with
- a '/'). `to_dir` is the directory where setuptools will be downloaded, if
- it is not already available.
-
- If an older version of setuptools is installed, this will print a message
- to ``sys.stderr`` and raise SystemExit in an attempt to abort the calling
- script.
- """
- try:
- import setuptools
- if setuptools.__version__ == '0.0.1':
- sys.stderr.write(
- "You have an obsolete version of setuptools installed. Please\n"
- "remove it from your system entirely before rerunning this script."
- )
- sys.exit(2)
-
- except ImportError:
- egg = download_setuptools(version, download_base, to_dir)
- sys.path.insert(0, egg)
- import setuptools; setuptools.bootstrap_install_from = egg
-
- import pkg_resources
- try:
- pkg_resources.require("setuptools>="+version)
-
- except pkg_resources.VersionConflict:
- # XXX could we install in a subprocess here?
- sys.stderr.write(
- "The required version of setuptools (>=%s) is not available, and\n"
- "can't be installed while this script is running. Please install\n"
- " a more recent version first."
- ) % version
- sys.exit(2)
-
-def download_setuptools(
- version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir
-):
- """Download setuptools from a specified location and return its filename
-
- `version` should be a valid setuptools version number that is available
- as an egg for download under the `download_base` URL (which should end
- with a '/'). `to_dir` is the directory where the egg will be downloaded.
- """
- from urllib2 import urlopen
- import shutil
- egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
- url = download_base + egg_name + '.zip' # XXX
- saveto = os.path.join(to_dir, egg_name)
- src = dst = None
-
- if not os.path.exists(saveto): # Avoid repeated downloads
- try:
- from distutils import log
- log.warn("Downloading %s", url)
- src = urlopen(url)
- # Read/write all in one block, so we don't create a corrupt file
- # if the download is interrupted.
- data = src.read()
- dst = open(saveto,"wb")
- dst.write(data)
- finally:
- if src: src.close()
- if dst: dst.close()
-
- return os.path.realpath(saveto)
-
-def main(argv, version=DEFAULT_VERSION):
- """Install or upgrade setuptools and EasyInstall"""
-
- try:
- import setuptools
- except ImportError:
- import tempfile, shutil
- tmpdir = tempfile.mkdtemp(prefix="easy_install-")
- try:
- egg = download_setuptools(version, to_dir=tmpdir)
- sys.path.insert(0,egg)
- from setuptools.command.easy_install import main
- main(list(argv)+[egg])
- finally:
- shutil.rmtree(tmpdir)
- else:
- if setuptools.__version__ == '0.0.1':
- # tell the user to uninstall obsolete version
- use_setuptools(version)
-
- req = "setuptools>="+version
- import pkg_resources
- try:
- pkg_resources.require(req)
- except pkg_resources.VersionConflict:
- try:
- from setuptools.command.easy_install import main
- except ImportError:
- from easy_install import main
- main(list(argv)+[download_setuptools()])
- sys.exit(0) # try to force an exit
- else:
- if argv:
- from setuptools.command.easy_install import main
- main(argv)
- else:
- print("Setuptools version",version,"or greater has been installed.")
- print('(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)')
-if __name__=='__main__':
- main(sys.argv[1:])
diff --git a/docs/cherryd.1 b/man/cherryd.1
index cf27a360..cf27a360 100644
--- a/docs/cherryd.1
+++ b/man/cherryd.1
diff --git a/release.py b/release.py
index 9d8d3333..26bad57e 100644
--- a/release.py
+++ b/release.py
@@ -1,37 +1,24 @@
"""
-This script will walk a developer through the process of cutting a release.
+Use jaraco.packaging with this script to cut a release. After installing
+jaraco.packaging, invoke:
-Based on https://bitbucket.org/cherrypy/cherrypy/wiki/ReleaseProcess
-
-To cut a release, simply invoke this script at the changeset to be released.
+python -m jaraco.packaging.release
"""
from __future__ import print_function
-import subprocess
import sys
import os
-import platform
import shutil
import importlib
-
-from six.moves import input
-
-VERSION='3.3.0'
-
-
-def get_next_version():
- print("The last release on this branch was {version}".format(
- version=VERSION))
- return input("What version are you releasing? ")
-
-NEXT_VERSION = get_next_version()
+import textwrap
files_with_versions = (
- 'release.py', 'setup.py', 'cherrypy/__init__.py',
- 'cherrypy/wsgiserver/wsgiserver2.py',
- 'cherrypy/wsgiserver/wsgiserver3.py',
- )
+ 'setup.py',
+ 'cherrypy/__init__.py',
+ 'cherrypy/wsgiserver/wsgiserver2.py',
+ 'cherrypy/wsgiserver/wsgiserver3.py',
+)
def check_wheel():
@@ -46,102 +33,30 @@ def check_wheel():
raise SystemExit(5)
-def check_status():
- """
- Make sure there aren't outstanding changesets that are unpushed, maybe
- run the tests or ask the user if the tests are passing.
- """
- print("You're about to release CherryPy {NEXT_VERSION}".format(
- **globals()))
- res = input('Have you run the tests with `nosetests -s ./` on '
- 'Windows, Linux, and Mac on at least Python '
- '2.4, 2.5, 2.7, and 3.2? '
- .format(**globals()))
- if not res.lower().startswith('y'):
- print("Please do that")
- raise SystemExit(1)
-
-
-def bump_versions():
- """
- Bump the versions in each of the places where it appears and commit.
- """
- list(map(bump_version, files_with_versions))
-
- subprocess.check_call(['hg', 'ci', '-m',
- 'Bumped to {NEXT_VERSION} in preparation for next '
- 'release.'.format(**globals())])
-
-
-def bump_version(filename):
- with open(filename, 'rb') as f:
- b_version = VERSION.encode('ascii')
- b_next_version = NEXT_VERSION.encode('ascii')
- lines = [line.replace(b_version, b_next_version) for line in f]
- with open(filename, 'wb') as f:
- f.writelines(lines)
-
+def before_upload():
+ check_wheel()
+ remove_files()
-def tag_release():
- """
- Tag the release.
- """
- subprocess.check_call(['hg', 'tag', NEXT_VERSION])
+test_info = textwrap.dedent("""
+ Run tests with `nosetests -s ./` on Windows, Linux, and Mac on at least
+ Python 2.4, 2.5, 2.7, and 3.2.
+ """).lstrip()
-dist_commands = ['sdist', 'bdist_wininst', 'bdist_wheel']
+dist_commands = 'sdist', 'bdist_wininst', 'bdist_wheel'
-def build():
+def remove_files():
if os.path.isfile('MANIFEST'):
os.remove('MANIFEST')
if os.path.isdir('dist'):
shutil.rmtree('dist')
- subprocess.check_call([sys.executable, 'setup.py'] + dist_commands)
-
-def push():
- "The build went well, so let's push the SCM changesets"
- subprocess.check_call(['hg', 'push', '-r', '.'])
-
-def publish():
- """
- Publish the dists on PyPI
- """
- try:
- upload_dist_command = [sys.executable, 'setup.py'] + dist_commands + ['register', 'upload']
- subprocess.check_call(upload_dist_command)
- except:
- print("Unable to upload the dist files. Ask in IRC for help access 57"
- "or assistance.")
- raise SystemExit(4)
+def announce():
print('Distributions have been uploaded.')
- print('Please ask in IRC for others to help you test '
- 'CherryPy {NEXT_VERSION}.'
- .format(**globals()))
+ print('Please ask in IRC for others to help you test this release.')
print("Please confirm that the distro installs properly "
- "with `easy_install CherryPy=={NEXT_VERSION}`.".format(**globals()))
-
-
-def announce():
+ "with `easy_install CherryPy=={version}`.".format(**globals()))
print("Please change the Wiki: Home page (news), CherryPyDownload")
print("Please announce the release on newsgroups, mailing lists, "
"and IRC /topic.")
-
-
-def main():
- assert sys.version_info >= (2, 6), ("Release script requires Python 2.6 "
- "or later.")
- assert platform.system() == 'Windows', ('You must release on Windows '
- '(to create Windows installers)')
- check_wheel()
- check_status()
- bump_versions()
- tag_release()
- build()
- push()
- publish()
- announce()
-
-if __name__ == '__main__':
- main()
diff --git a/setup.cfg b/setup.cfg
index 8a8e58cd..cd62b8dd 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -6,6 +6,3 @@ where=cherrypy
logging-filter=cherrypy
verbosity=2
nocapture=True
-
-[wheel]
-universal=1
diff --git a/setup.py b/setup.py
index 8441be92..c09768ca 100644
--- a/setup.py
+++ b/setup.py
@@ -36,7 +36,7 @@ class cherrypy_build_py(build_py):
# arguments for the setup command
###############################################################################
name = "CherryPy"
-version = "3.3.0"
+version = "3.5.1"
desc = "Object-Oriented HTTP framework"
long_desc = "CherryPy is a pythonic, object-oriented HTTP framework"
classifiers = [
@@ -126,6 +126,21 @@ else:
if 'bdist_wininst' in sys.argv or '--format=wininst' in sys.argv:
data_files = [(r'\PURELIB\%s' % path, files) for path, files in data_files]
+setup_params = dict(
+ name=name,
+ version=version,
+ description=desc,
+ long_description=long_desc,
+ classifiers=classifiers,
+ author=author,
+ author_email=author_email,
+ url=url,
+ license=cp_license,
+ packages=packages,
+ data_files=data_files,
+ scripts=scripts,
+ cmdclass=cmd_class,
+)
def main():
if sys.version < required_python_version:
@@ -137,21 +152,7 @@ def main():
for scheme in list(INSTALL_SCHEMES.values()):
scheme['data'] = scheme['purelib']
- setup(
- name=name,
- version=version,
- description=desc,
- long_description=long_desc,
- classifiers=classifiers,
- author=author,
- author_email=author_email,
- url=url,
- license=cp_license,
- packages=packages,
- data_files=data_files,
- scripts=scripts,
- cmdclass=cmd_class,
- )
+ setup(**setup_params)
if __name__ == "__main__":
diff --git a/sphinx/Makefile b/sphinx/Makefile
deleted file mode 100644
index a0653b16..00000000
--- a/sphinx/Makefile
+++ /dev/null
@@ -1,89 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = build
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-clean:
- -rm -rf $(BUILDDIR)/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CherryPy.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CherryPy.qhc"
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
- "run these through (pdf)latex."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/sphinx/make.bat b/sphinx/make.bat
deleted file mode 100644
index 8a496f9e..00000000
--- a/sphinx/make.bat
+++ /dev/null
@@ -1,113 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-set SPHINXBUILD=sphinx-build
-set BUILDDIR=build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
-if NOT "%PAPER%" == "" (
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
- :help
- echo.Please use `make ^<target^>` where ^<target^> is one of
- echo. html to make standalone HTML files
- echo. dirhtml to make HTML files named index.html in directories
- echo. pickle to make pickle files
- echo. json to make JSON files
- echo. htmlhelp to make HTML files and a HTML help project
- echo. qthelp to make HTML files and a qthelp project
- echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
- echo. changes to make an overview over all changed/added/deprecated items
- echo. linkcheck to check all external links for integrity
- echo. doctest to run all doctests embedded in the documentation if enabled
- goto end
-)
-
-if "%1" == "clean" (
- for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
- del /q /s %BUILDDIR%\*
- goto end
-)
-
-if "%1" == "html" (
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/html.
- goto end
-)
-
-if "%1" == "dirhtml" (
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
- goto end
-)
-
-if "%1" == "pickle" (
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
- echo.
- echo.Build finished; now you can process the pickle files.
- goto end
-)
-
-if "%1" == "json" (
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
- echo.
- echo.Build finished; now you can process the JSON files.
- goto end
-)
-
-if "%1" == "htmlhelp" (
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
- echo.
- echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
- goto end
-)
-
-if "%1" == "qthelp" (
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
- echo.
- echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\CherryPy.qhcp
- echo.To view the help file:
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\CherryPy.ghc
- goto end
-)
-
-if "%1" == "latex" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
- echo.
- echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
- goto end
-)
-
-if "%1" == "changes" (
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
- echo.
- echo.The overview file is in %BUILDDIR%/changes.
- goto end
-)
-
-if "%1" == "linkcheck" (
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
- echo.
- echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
- goto end
-)
-
-if "%1" == "doctest" (
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
- echo.
- echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
- goto end
-)
-
-:end
diff --git a/sphinx/source/appendix/cherrypyspeed.rst b/sphinx/source/appendix/cherrypyspeed.rst
deleted file mode 100644
index 90580a40..00000000
--- a/sphinx/source/appendix/cherrypyspeed.rst
+++ /dev/null
@@ -1,521 +0,0 @@
-.. _cherrypyspeed:
-
-*********************
-How fast is CherryPy?
-*********************
-
-Introduction
-============
-
-When people ask this question, they usually mean "how fast will my CherryPy-based application be?".
-
-In 99% of the cases, the answer is "this depends on your actual application code, not on CherryPy itself".
-
-The reason is that, for 99% of the real-world dynamic applications, most of the time spent to return a page will be spent in your actual application code, and the time actually spent in the CherryPy code will be negligible.
-
-For instance, a typical page that requires a few database calls to be built might take in total 200ms to be served. Out of these 200ms, about 2ms will be spent by CherryPy itself, and 198ms will be spend in your actual database calls and page rendering...
-
-So you can see that, if you want to optimize anything, you should really optimize your actual application code before you try to optimize CherryPy.
-
-
-Raw speed of the CherryPy HTTP server
-=====================================
-
-Despite the real-life most common scenario explained in the introduction, some people still want to know the raw speed of the CherryPy HTTP server.
-
-About the benchmark
--------------------
-
-This benchmarking only makes sense on very small documents, otherwise we're no longer measuring the raw speed of the HTTP server, but also the speed of the application.
-
-.. warning::
-
- This benchmark uses the ``ab`` tool from the Apache project, it's far from being a perfect tool nor does it provide a realistic user workflow. Take these results lightly and always perform real load/performance tests in your environment with better tools.
-
-This benchmarking was performed on a laptop in the following environment:
- * Processor: Intel® Core™ i3-2330M CPU @ 2.20GHz × 4
- * RAM: 4GB
- * Ubuntu 13.10
- * Python 2.7
- * CherryPy 3.2.4
- * Load testing tool: ab from Apache2
-
-We used the following basic CherryPy app:
-
-.. code-block:: python
-
- import cherrypy
-
- class Root(object):
- def index(self):
- return "OK"
- index.exposed = True
-
- if __name__ == "__main__":
- # remove the default CherryPy enabled tools
- # to really check the speed of the request processing stack
- cherrypy.config.clear()
-
- # we don't need the logging for this test
- cherrypy.config.update({'log.screen': False})
-
- cherrypy.quickstart(Root())
-
-For the raw WSGI server tests, we used the following code:
-
-.. code-block:: python
-
- from cherrypy import wsgiserver
-
- def my_crazy_app(environ, start_response):
- start_response('200 OK', [('Content-type','text/plain')])
- return ['OK']
-
- if __name__ == '__main__':
- server = wsgiserver.CherryPyWSGIServer(
- ('0.0.0.0', 8080), my_crazy_app)
- server.stats['Enabled'] = False
- try:
- server.start()
- except KeyboardInterrupt:
- server.stop()
-
-
-Test 1: Dynamic content / no concurrent connections
----------------------------------------------------
-
-.. code-block:: text
-
- $ ab -n 1000 http://localhost:8080/
- This is ApacheBench, Version 2.3 <$Revision: 1430300 $>
- Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
- Licensed to The Apache Software Foundation, http://www.apache.org/
-
- Benchmarking localhost (be patient)
- Completed 100 requests
- Completed 200 requests
- Completed 300 requests
- Completed 400 requests
- Completed 500 requests
- Completed 600 requests
- Completed 700 requests
- Completed 800 requests
- Completed 900 requests
- Completed 1000 requests
- Finished 1000 requests
-
-
- Server Software: CherryPy/3.2.4
- Server Hostname: localhost
- Server Port: 8080
-
- Document Path: /
- Document Length: 2 bytes
-
- Concurrency Level: 1
- Time taken for tests: 2.414 seconds
- Complete requests: 1000
- Failed requests: 0
- Write errors: 0
- Total transferred: 126000 bytes
- HTML transferred: 2000 bytes
- Requests per second: 414.19 [#/sec] (mean)
- Time per request: 2.414 [ms] (mean)
- Time per request: 2.414 [ms] (mean, across all concurrent requests)
- Transfer rate: 50.96 [Kbytes/sec] received
-
- Connection Times (ms)
- min mean[+/-sd] median max
- Connect: 0 0 0.0 0 1
- Processing: 1 2 0.6 2 8
- Waiting: 1 2 0.5 2 5
- Total: 1 2 0.6 2 8
-
- Percentage of the requests served within a certain time (ms)
- 50% 2
- 66% 2
- 75% 2
- 80% 2
- 90% 3
- 95% 3
- 98% 4
- 99% 5
- 100% 8 (longest request)
-
-
-Test 2: Dynamic content / concurrent connections / persistent connections
--------------------------------------------------------------------------
-
-.. code-block:: text
-
- $ ab -k -n 1000 http://localhost:8080/
- This is ApacheBench, Version 2.3 <$Revision: 1430300 $>
- Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
- Licensed to The Apache Software Foundation, http://www.apache.org/
-
- Benchmarking localhost (be patient)
- Completed 100 requests
- Completed 200 requests
- Completed 300 requests
- Completed 400 requests
- Completed 500 requests
- Completed 600 requests
- Completed 700 requests
- Completed 800 requests
- Completed 900 requests
- Completed 1000 requests
- Finished 1000 requests
-
-
- Server Software: CherryPy/3.2.4
- Server Hostname: localhost
- Server Port: 8080
-
- Document Path: /
- Document Length: 2 bytes
-
- Concurrency Level: 1
- Time taken for tests: 0.626 seconds
- Complete requests: 1000
- Failed requests: 0
- Write errors: 0
- Keep-Alive requests: 1000
- Total transferred: 150000 bytes
- HTML transferred: 2000 bytes
- Requests per second: 1597.89 [#/sec] (mean)
- Time per request: 0.626 [ms] (mean)
- Time per request: 0.626 [ms] (mean, across all concurrent requests)
- Transfer rate: 234.07 [Kbytes/sec] received
-
- Connection Times (ms)
- min mean[+/-sd] median max
- Connect: 0 0 0.0 0 0
- Processing: 1 1 0.2 1 3
- Waiting: 1 1 0.2 1 3
- Total: 1 1 0.2 1 3
-
- Percentage of the requests served within a certain time (ms)
- 50% 1
- 66% 1
- 75% 1
- 80% 1
- 90% 1
- 95% 1
- 98% 1
- 99% 2
- 100% 3 (longest request)
-
-Test 3: Dynamic content / concurrent connections
-------------------------------------------------
-
-Now let's alo tell "ab" to simulate 10 concurrent users.
-
-.. code-block:: text
-
- $ ab -c 10 -n 1000 http://localhost:8080/
- This is ApacheBench, Version 2.3 <$Revision: 1430300 $>
- Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
- Licensed to The Apache Software Foundation, http://www.apache.org/
-
- Benchmarking localhost (be patient)
- Completed 100 requests
- Completed 200 requests
- Completed 300 requests
- Completed 400 requests
- Completed 500 requests
- Completed 600 requests
- Completed 700 requests
- Completed 800 requests
- Completed 900 requests
- Completed 1000 requests
- Finished 1000 requests
-
-
- Server Software: CherryPy/3.2.4
- Server Hostname: localhost
- Server Port: 8080
-
- Document Path: /
- Document Length: 2 bytes
-
- Concurrency Level: 10
- Time taken for tests: 2.653 seconds
- Complete requests: 1000
- Failed requests: 0
- Write errors: 0
- Total transferred: 126000 bytes
- HTML transferred: 2000 bytes
- Requests per second: 376.99 [#/sec] (mean)
- Time per request: 26.526 [ms] (mean)
- Time per request: 2.653 [ms] (mean, across all concurrent requests)
- Transfer rate: 46.39 [Kbytes/sec] received
-
- Connection Times (ms)
- min mean[+/-sd] median max
- Connect: 0 2 44.7 0 1000
- Processing: 5 21 33.7 17 406
- Waiting: 4 20 33.7 16 406
- Total: 5 23 55.9 17 1020
-
- Percentage of the requests served within a certain time (ms)
- 50% 17
- 66% 19
- 75% 20
- 80% 21
- 90% 23
- 95% 25
- 98% 31
- 99% 286
- 100% 1020 (longest request)
-
-
-Test 4: Dynamic content / concurrent connections / persistent connections
--------------------------------------------------------------------------
-
-In this use case, we tell ab to reuse connections as per HTTP/1.1.
-
-.. code-block:: text
-
- $ ab -k -c 10 -n 1000 http://localhost:8080/
- This is ApacheBench, Version 2.3 <$Revision: 1430300 $>
- Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
- Licensed to The Apache Software Foundation, http://www.apache.org/
-
- Benchmarking localhost (be patient)
- Completed 100 requests
- Completed 200 requests
- Completed 300 requests
- Completed 400 requests
- Completed 500 requests
- Completed 600 requests
- Completed 700 requests
- Completed 800 requests
- Completed 900 requests
- Completed 1000 requests
- Finished 1000 requests
-
-
- Server Software: CherryPy/3.2.4
- Server Hostname: localhost
- Server Port: 8080
-
- Document Path: /
- Document Length: 2 bytes
-
- Concurrency Level: 10
- Time taken for tests: 1.944 seconds
- Complete requests: 1000
- Failed requests: 0
- Write errors: 0
- Keep-Alive requests: 1000
- Total transferred: 150000 bytes
- HTML transferred: 2000 bytes
- Requests per second: 514.36 [#/sec] (mean)
- Time per request: 19.442 [ms] (mean)
- Time per request: 1.944 [ms] (mean, across all concurrent requests)
- Transfer rate: 75.35 [Kbytes/sec] received
-
- Connection Times (ms)
- min mean[+/-sd] median max
- Connect: 0 1 31.6 0 1000
- Processing: 1 18 16.6 16 424
- Waiting: 1 14 15.6 12 418
- Total: 1 19 36.3 16 1040
-
- Percentage of the requests served within a certain time (ms)
- 50% 16
- 66% 21
- 75% 24
- 80% 26
- 90% 32
- 95% 38
- 98% 47
- 99% 51
- 100% 1040 (longest request)
-
-
-Test 5: Raw WSGI server / no concurrent connections
----------------------------------------------------
-
-.. code-block:: text
-
- $ ab -n 1000 http://localhost:8080/
- This is ApacheBench, Version 2.3 <$Revision: 1430300 $>
- Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
- Licensed to The Apache Software Foundation, http://www.apache.org/
-
- Benchmarking localhost (be patient)
- Completed 100 requests
- Completed 200 requests
- Completed 300 requests
- Completed 400 requests
- Completed 500 requests
- Completed 600 requests
- Completed 700 requests
- Completed 800 requests
- Completed 900 requests
- Completed 1000 requests
- Finished 1000 requests
-
-
- Server Software: sylvain-laptop
- Server Hostname: localhost
- Server Port: 8080
-
- Document Path: /
- Document Length: 2 bytes
-
- Concurrency Level: 1
- Time taken for tests: 1.041 seconds
- Complete requests: 1000
- Failed requests: 0
- Write errors: 0
- Total transferred: 108000 bytes
- HTML transferred: 2000 bytes
- Requests per second: 960.58 [#/sec] (mean)
- Time per request: 1.041 [ms] (mean)
- Time per request: 1.041 [ms] (mean, across all concurrent requests)
- Transfer rate: 101.31 [Kbytes/sec] received
-
- Connection Times (ms)
- min mean[+/-sd] median max
- Connect: 0 0 0.0 0 0
- Processing: 0 1 0.3 1 4
- Waiting: 0 1 0.3 1 4
- Total: 0 1 0.3 1 4
-
- Percentage of the requests served within a certain time (ms)
- 50% 1
- 66% 1
- 75% 1
- 80% 1
- 90% 1
- 95% 1
- 98% 2
- 99% 2
- 100% 4 (longest request)
-
-
-Test 6: Raw WSGI server / concurrent connections
-------------------------------------------------
-
-.. code-block:: text
-
- $ ab -c 10 -n 1000 http://localhost:8080/
- This is ApacheBench, Version 2.3 <$Revision: 1430300 $>
- Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
- Licensed to The Apache Software Foundation, http://www.apache.org/
-
- Benchmarking localhost (be patient)
- Completed 100 requests
- Completed 200 requests
- Completed 300 requests
- Completed 400 requests
- Completed 500 requests
- Completed 600 requests
- Completed 700 requests
- Completed 800 requests
- Completed 900 requests
- Completed 1000 requests
- Finished 1000 requests
-
-
- Server Software: sylvain-laptop
- Server Hostname: localhost
- Server Port: 8080
-
- Document Path: /
- Document Length: 2 bytes
-
- Concurrency Level: 10
- Time taken for tests: 1.235 seconds
- Complete requests: 1000
- Failed requests: 0
- Write errors: 0
- Total transferred: 108000 bytes
- HTML transferred: 2000 bytes
- Requests per second: 809.88 [#/sec] (mean)
- Time per request: 12.348 [ms] (mean)
- Time per request: 1.235 [ms] (mean, across all concurrent requests)
- Transfer rate: 85.42 [Kbytes/sec] received
-
- Connection Times (ms)
- min mean[+/-sd] median max
- Connect: 0 1 31.5 0 996
- Processing: 2 8 19.4 7 341
- Waiting: 1 8 19.4 6 341
- Total: 2 9 37.0 7 1003
-
- Percentage of the requests served within a certain time (ms)
- 50% 7
- 66% 7
- 75% 8
- 80% 8
- 90% 10
- 95% 11
- 98% 15
- 99% 17
- 100% 1003 (longest request)
-
-
-Test 7: Raw WSGI server / concurrent connections / persistent connections
--------------------------------------------------------------------------
-
-.. code-block:: text
-
- $ ab -k -c 10 -n 1000 http://localhost:8080/
- This is ApacheBench, Version 2.3 <$Revision: 1430300 $>
- Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
- Licensed to The Apache Software Foundation, http://www.apache.org/
-
- Benchmarking localhost (be patient)
- Completed 100 requests
- Completed 200 requests
- Completed 300 requests
- Completed 400 requests
- Completed 500 requests
- Completed 600 requests
- Completed 700 requests
- Completed 800 requests
- Completed 900 requests
- Completed 1000 requests
- Finished 1000 requests
-
-
- Server Software: sylvain-laptop
- Server Hostname: localhost
- Server Port: 8080
-
- Document Path: /
- Document Length: 2 bytes
-
- Concurrency Level: 10
- Time taken for tests: 0.992 seconds
- Complete requests: 1000
- Failed requests: 0
- Write errors: 0
- Keep-Alive requests: 0
- Total transferred: 108000 bytes
- HTML transferred: 2000 bytes
- Requests per second: 1008.08 [#/sec] (mean)
- Time per request: 9.920 [ms] (mean)
- Time per request: 0.992 [ms] (mean, across all concurrent requests)
- Transfer rate: 106.32 [Kbytes/sec] received
-
- Connection Times (ms)
- min mean[+/-sd] median max
- Connect: 0 0 0.1 0 1
- Processing: 1 7 22.8 6 345
- Waiting: 0 7 22.7 5 344
- Total: 1 7 22.8 6 345
-
- Percentage of the requests served within a certain time (ms)
- 50% 6
- 66% 7
- 75% 7
- 80% 7
- 90% 9
- 95% 10
- 98% 11
- 99% 13
- 100% 345 (longest request)
diff --git a/sphinx/source/appendix/faq.rst b/sphinx/source/appendix/faq.rst
deleted file mode 100644
index 7aadbb60..00000000
--- a/sphinx/source/appendix/faq.rst
+++ /dev/null
@@ -1,207 +0,0 @@
-.. _faq:
-
-**************************
-Frequently Asked Questions
-**************************
-
-General
-=======
-
-:Q: How fast is CherryPy ?
-
-:A: Have a look at :doc:`/appendix/cherrypyspeed`.
-
-:Q: When will it be added to the standard python library?
-
-:A: Probably never. The standard python library is not the place to distribute
- an application server.
-
-:Q: Who uses CherryPy?
-
-:A: See :ref:`SuccessStories`.
-
-
-Server Features and Configuration
-=================================
-
-:Q: How do I serve multiple domains on one host?
-
-:A: You can use the :class:`cherrypy._cpdispatch.VirtualHost` dispatcher.
-
-:Q: Does CherryPy support https?
-
-:A: CherryPy has built-in SSL support as of 3.0.0beta. See the `ssl_*`
- properties of :mod:`cherrypy._cpserver` and the :doc:`programmer's guide </progguide/security>`.
-
- Earlier versions do not have built-in SSL support, but Tim Evans has
- written a module called `SslCherry <http://tools.cherrypy.org/wiki/SSLWithM2Crypto>`_
- that uses M2Crypto for https support. It's not quite ready for production
- use, but it looks promising.
-
-:Q: Does CherryPy prevent cross-site scripting?
-
-:A: See `Malicious HTML Tags Embedded in Client Web Requests <http://www.cert.org/advisories/CA-2000-02.html>`_
- and `Understanding Malicious Content Mitigation for Web Developers <http://www.cert.org/tech_tips/malicious_code_mitigation.html>`_
- at `CERT <http://www.cert.org/>`_ for an overview of Cross-Site Scripting
- (XSS) issues.
-
- While it is ultimately up to the developer to remove potential XSS
- vulnerabilities from their apps and sites, there are several Cherrypy
- settings that can help. They are discussed in the
- :doc:`programmer's guide </progguide/security>`.
-
-:Q: Why does CherryPy take CPU/RAM even though it's not yet receiving requests?
-
-:A: CherryPy runs some tasks in the background by default, and some when you
- turn on certain tools. To strip CherryPy down to nothing, you might have to:
-
- * Turn off the :ref:`timeoutmonitor`
- via ``cherrypy.engine.timeout_monitor.unsubscribe()``.
- * Turn off the :class:`Autoreloader <cherrypy.process.plugins.Autoreloader>`
- via ``cherrypy.engine.autoreload.unsubscribe()``.
- * Examine the number of worker threads that WSGIServer uses.
- See :attr:`cherrypy._cpserver.Server.thread_pool`.
-
-:Q: CherryPy serves my HTML but not my CSS, Javascript, or images. Why does
- CherryPy wait to serve one resource before serving the next? Can it not
- handle more than one connection at a time?
-
-:A: CherryPy certainly can handle multiple connections. It's usually your
- browser that is the culprit. Firefox, for example, will only open two
- connections at a time to the same host (and if one of those is for the
- ``favicon.ico``, then you're down to one). Try increasing the number of
- concurrent connections your browser makes, or test your site with a tool
- that isn't a browser, like ``siege``, Apache's ``ab``, or even ``curl``.
-
-Development Questions
-=====================
-
-:Q: I can browse pages from my local machine, but not from other machines. What gives?
-
-:A: Set the config entry `server.socket_host` to either your server name/IP,
- or to '0.0.0.0' to listen on all interfaces.
- See :mod:`cherrypy._cpserver` for more details.
-
-:Q: How do I serve URL's with dots in them, like "/path/to/report.xml"?
-
-:A: Two ways: 1) Convert the dots to underscores for your page handler names,
- e.g. ``def report_xml(self)``
- (see :ref:`defaultdispatcher`) or 2) use a :ref:`default method<defaultmethods>`.
-
-:Q: How do I upload BIG files? (Or what is the best thing to do if I have many
- concurrent users uploading files?)
-
-:A: Please see :doc:`/progguide/files/uploading` for examples.
-
-:Q: Can I perform HTTP based authentication (.htaccess)?
-
-:A: There are two tools implementing :rfc:`2617`: :doc:`/refman/lib/auth_digest`
- and :doc:`/refman/lib/auth_basic`.
-
-:Q: What templating systems does CherryPy support?
-
-:A: All of them! One of the core idea of CherryPy is to be templating
- language independent. It is important to us to let developers keep
- their habits and preferred tools. Hence CherryPy does not favor any
- templating language. But for some ideas, see
- :doc:`/progguide/choosingtemplate` and the
- `Tools wiki <http://tools.cherrypy.org/wiki/>`_.
-
-:Q: My default handler throws an exception complaining about the number of
- arguments. How to handle this?
-
-:A: Suppose you have the following handler class setup: ::
-
- class Root:
- def project(self, id):
- data = db.query("project", id)
- return "Details for project %d: %r" % (id, data)
-
- and you want to provide project information based on urls of the form ::
-
- /project/123
-
- Here, 123 is a project id to search in a database. The above project()
- method will do the trick, but, when someone adds more arguments than the
- method expects, e.g. ::
-
- /project/123/456/789?x=blah
-
- those extra elements are passed on to the project() method as parameters, which
- is not able to handle the extra arguments and results in an exception being thrown.
-
- You can catch this by appending ``*args``, ``**kwargs`` to the default()
- method's parameter list. This way, the values 456 and 789 in the example
- will be placed in the 'args' list and the 'kwargs' dictionary will contain
- the string 'blah' for the key 'x'. In the following example, we just
- ignore any extra params: ::
-
- class Root:
- def project(self, id, *args, **kwargs):
- data = db.query("project", id)
- return "Details for project %d: %r" % (id, data)
-
-:Q: How do I publish objects with reserved Python names?
-
-:A: Example: ::
-
- class SomeClass(object):
- def __init__(self):
- setattr(self, 'print', self._print)
- setattr(self, 'class', self._class)
-
- def _print(self):
- ...
- _print.exposed = True
-
- def _class(self):
- ...
- _class.exposed = True
-
- Object attributes can have reserved names as long as you dynamically
- bind them so the Python parser doesn't choke on them.
-
-:Q: How does CherryPy compare to projects like mod_python, Twisted, and Django?
-
-:A: mod_python requires you to be running `Apache <http://httpd.apache.org/>`_.
- See http://www.modpython.org for more info. Since CherryPy 2.1, you can
- use mod_python as an interface to bridge CherryPy and Apache.
-
- Twisted is, well, twisted. You really have to spend the time to understand
- how the twisted framework works. It is deep and very powerful, but has a
- steep learning curve. CherryPy is, arguably, simpler to understand, due to
- its more traditional approach. Part of this comes from it not trying to do
- all the things that twisted does (SMTP, IRC, NNTP, etc etc). See
- http://twistedmatrix.com for more info.
-
- For a 3rd party discussion, refer to the
- `PyWebOff blog <http://pyre.third-bit.com/pyweb/index.html>`_ which concluded:
-
- "In no time at all, I was finished the library program. It took me
- significantly less time than it did with either of Quixote or Webware,
- and I'm very happy with the code that was produced. CherryPy needs more
- documenting, but otherwise it gets two enthusiastic thumbs up."
-
-:Q: When you run cherrypy and two dudes browse your website at the same time,
- does cherrypy create two instances of your root object? How does that work?
- I don't get it.
-
-:A: No, just one instance. It's no different than having two threads in any
- other Python application call the same method at the same time: each
- thread has its own set of local variables so they don't stomp each other.
-
-:Q: How do I get CherryPy to work if I don't have root?
-
-:A: Just append it to the path. Put the following at the top of the files
- you need CherryPy for: ::
-
- import sys
- sys.path.append("your local dir path")
-
-:Q: Can I change my root class, refresh my web page and see what is changed
- without restarting the CherryPy server?
-
-:A: See :class:`cherrypy.process.plugins.Autoreloader`. Note that this solution
- works properly only if the changes you make are syntactically correct.
- Re-compilation errors will exit the entire application.
-
diff --git a/sphinx/source/appendix/index.rst b/sphinx/source/appendix/index.rst
deleted file mode 100644
index 0f79c15b..00000000
--- a/sphinx/source/appendix/index.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-********
-Appendix
-********
-
-.. toctree::
- :maxdepth: 2
- :glob:
-
- *
-
-
diff --git a/sphinx/source/appendix/success.rst b/sphinx/source/appendix/success.rst
deleted file mode 100644
index b05587da..00000000
--- a/sphinx/source/appendix/success.rst
+++ /dev/null
@@ -1,87 +0,0 @@
-.. _successstories:
-
-***************
-Success Stories
-***************
-
-You are interested in CherryPy but you would like to hear more from people
-using it, or simply check out products or application running it.
-
-If you would like to have your CherryPy powered website or product listed here,
-contact us via our `mailing list <http://groups.google.com/group/cherrypy-users>`_
-or IRC (#cherrypy on `OFTC <http://www.oftc.net/oftc/>`_).
-
-
-Websites running atop CherryPy
-==============================
-
-`Hulu Deejay and Hulu Sod <http://tech.hulu.com/blog/2013/03/13/python-and-hulu>`_ - Hulu uses
-CherryPy for some projects.
-"The service needs to be very high performance.
-Python, together with CherryPy,
-`gunicorn <http://gunicorn.org>`_, and gevent more than provides for this."
-
-`Netflix <http://techblog.netflix.com/2013/03/python-at-netflix.html>`_ - Netflix uses CherryPy as a building block in their infrastructure: "Restful APIs to
-large applications with requests, providing web interfaces with CherryPy and Bottle,
-and crunching data with scipy."
-
-`Urbanility <http://urbanility.com>`_ - French website for local neighbourhood assets in Rennes, France.
-
-`MROP Supply <https://www.mropsupply.com>`_ - Webshop for industrial equipment,
-developed using CherryPy 3.2.2 utilizing Python 3.2,
-with libs: `Jinja2-2.6 <http://jinja.pocoo.org/docs>`_, davispuh-MySQL-for-Python-3-3403794,
-pyenchant-1.6.5 (for search spelling).
-"I'm coming over from .net development and found Python and CherryPy to
-be surprisingly minimalistic. No unnecessary overhead - build everything you
-need without the extra fluff. I'm a fan!"
-
-`CherryMusic <http://www.fomori.org/cherrymusic>`_ - A music streaming server written in python:
-Stream your own music collection to all your devices! CherryMusic is open source.
-
-`YouGov Global <http://www.yougov.com>`_ - International market research firm, conducts
-millions of surveys on CherryPy yearly.
-
-`Aculab Cloud <http://cloud.aculab.com>`_ - Voice and fax applications on the cloud.
-A simple telephony API for Python, C#, C++, VB, etc...
-The website and all front-end and back-end web services are built with CherryPy,
-fronted by nginx (just handling the ssh and reverse-proxy), and running on AWS in two regions.
-
-`Learnit Training <http://www.learnit.nl>`_ - Dutch website for an IT, Management and
-Communication training company. Built on CherryPy 3.2.0 and Python 2.7.3, with
-`oursql <http://pythonhosted.org/oursql>`_ and
-`DBUtils <http://www.webwareforpython.org/DBUtils>`_ libraries, amongst others.
-
-`Linstic <http://linstic.com>`_ - Sticky Notes in your browser (with linking).
-
-`Almad's Homepage <http://www.almad.net>`_ - Simple homepage with blog.
-
-
-Products based on CherryPy
-==========================
-
-`SABnzbd <http://sabnzbd.org>`_ - Open Source Binary Newsreader written in Python.
-
-`Headphones <https://github.com/rembo10/headphones>`_ - Third-party add-on for SABnzbd.
-
-`SickBeard <http://sickbeard.com>`_ - "Sick Beard is a PVR for newsgroup users (with limited torrent support). It watches for new episodes of your favorite shows and when they are posted it downloads them, sorts and renames them, and optionally generates metadata for them."
-
-`TurboGears <http://www.turbogears.org>`_ - The rapid web development megaframework. Turbogears 1.x used Cherrypy. "CherryPy is the underlying application server for TurboGears. It is responsible for taking the requests from the user’s browser, parses them and turns them into calls into the Python code of the web application. Its role is similar to application servers used in other programming languages".
-
-`Indigo <http://www.perceptiveautomation.com/indigo/index.html>`_ - "An intelligent home control
-server that integrates home control hardware modules to provide control of your home. Indigo's built-in
-Web server and client/server architecture give you control and access to your home remotely from
-other Macs, PCs, internet tablets, PDAs, and mobile phones."
-
-`SlikiWiki <http://www.sf.net/projects/slikiwiki>`_ - Wiki built on CherryPy and featuring WikiWords, automatic backlinking, site map generation, full text search, locking for concurrent edits, RSS feed embedding, per page access control lists, and page formatting using PyTextile markup."
-
-`read4me <http://sourceforge.net/projects/read4me>`_ - read4me is a Python feed-reading web service.
-
-`Firebird QA tools <http://www.firebirdsql.org/en/quality-assurance>`_ - Firebird QA tools are based on CherryPy.
-
-`salt-api <https://github.com/saltstack/salt-api>`_ - A REST API for Salt, the infrastructure orchestration tool.
-
-Products inspired by CherryPy
-=============================
-
-`OOWeb <http://ooweb.sourceforge.net/>`_ - "OOWeb is a lightweight, embedded HTTP server for Java applications that maps objects to URL directories, methods to pages and form/querystring arguments as method parameters. OOWeb was originally inspired by CherryPy."
-
diff --git a/sphinx/source/deployguide/apache.rst b/sphinx/source/deployguide/apache.rst
deleted file mode 100644
index 9d9aa783..00000000
--- a/sphinx/source/deployguide/apache.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-********************************
-Deploying CherryPy behind Apache
-********************************
-
diff --git a/sphinx/source/deployguide/cherryd.rst b/sphinx/source/deployguide/cherryd.rst
deleted file mode 100644
index bca18396..00000000
--- a/sphinx/source/deployguide/cherryd.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-*******
-cherryd
-*******
-
-The ``cherryd`` script is used to start CherryPy servers, whether the builtin
-WSGI server, :ref:`FastCGI <fastcgi>`, or SCGI. Sites using mod_python don't
-need to use ``cherryd``; Apache will spawn the CherryPy process in that case.
-
-Command-Line Options
-====================
-
-.. program:: cherryd
-
-.. cmdoption:: -c, --config
-
- Specify config file(s)
-
-.. cmdoption:: -d
-
- Run the server as a daemon
-
-.. cmdoption:: -e, --environment
-
- Apply the given config environment (defaults to None)
-
-
-.. index:: FastCGI
-
-.. cmdoption:: -f
-
- Start a :ref:`FastCGI <fastcgi>` server instead of the default HTTP server
-
-
-.. index:: SCGI
-
-.. cmdoption:: -s
-
- Start a SCGI server instead of the default HTTP server
-
-
-.. cmdoption:: -i, --import
-
- Specify modules to import
-
-
-.. index:: PID file
-
-.. cmdoption:: -p, --pidfile
-
- Store the process id in the given file (defaults to None)
-
-
-.. cmdoption:: -P, --Path
-
- Add the given paths to sys.path
-
diff --git a/sphinx/source/deployguide/index.rst b/sphinx/source/deployguide/index.rst
deleted file mode 100644
index c8eff7bb..00000000
--- a/sphinx/source/deployguide/index.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-****************
-Deployment Guide
-****************
-
-CherryPy the application framework is quite flexible and can be deployed in a
-wide variety of ways. CherryPy the server is a production-ready, performant
-server that can be used to deploy any WSGI or CGI application.
-
-Applications
-============
-
-An easy way to deploy a CherryPy application is using the standard
-``quickstart()`` server. The ``cherryd`` script mentioned below wraps this same
-server. It is a production-ready, performant server that can be quickly
-configured for development or production use (or even somewhere in-between) by
-setting an :ref:`environment <environments>` in the application config.
-
-A CherryPy application can also be deployed using any WSGI-capable server. The
-return from :py:class:`cherrypy.tree.mount <cherrypy._cptree.Tree>` is a
-standard WSGI application.
-
-Servers
-=======
-
-CherryPy ships with a fast, production-ready server that can be used to serve
-applications independently of the CherryPy application framework.
-
-.. toctree::
- :maxdepth: 2
-
- apache
- /refman/process/servers
- /refman/wsgiserver/init
-
-
-Environment
-===========
-
-.. toctree::
- :maxdepth: 2
-
- cherryd
- /refman/process/plugins/daemonizer
- /refman/process/plugins/dropprivileges
- /refman/process/plugins/pidfile
- /refman/process/plugins/signalhandler
-
-
diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst
deleted file mode 100644
index 492bdbbf..00000000
--- a/sphinx/source/index.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-.. toctree::
- :hidden:
-
- intro/index
- tutorial/index
- progguide/index
- deployguide/index
- refman/index
- appendix/index
-
-
-********************************
-CherryPy |release| Documentation
-********************************
-
-:doc:`Introduction <intro/index>`
----------------------------------
-The who, what, and why of CherryPy
-
-:doc:`Tutorial <tutorial/index>`
----------------------------------
-The basics of CherryPy
-
-:doc:`Programmer's Guide <progguide/index>`
--------------------------------------------
-How to perform common tasks
-
-:doc:`Deployment Guide <deployguide/index>`
--------------------------------------------
-Getting your application running and on the web
-
-:doc:`Reference Manual <refman/index>`
---------------------------------------
-Module, class, and function reference
-
-:doc:`Appendix <appendix/index>`
---------------------------------
-:doc:`FAQ </appendix/faq>`, :doc:`Performance benchmarking </appendix/cherrypyspeed>`, and :doc:`Success Stories </appendix/success>`
-
-Other
------
-
-:ref:`genindex`
-
-:ref:`modindex`
-
-:ref:`search`
-
diff --git a/sphinx/source/intro/index.rst b/sphinx/source/intro/index.rst
deleted file mode 100644
index cf5a5951..00000000
--- a/sphinx/source/intro/index.rst
+++ /dev/null
@@ -1,84 +0,0 @@
-************
-Introduction
-************
-
-What is CherryPy?
-=================
-
-CherryPy is a pythonic, object-oriented HTTP framework.
-
-CherryPy allows developers to build web applications in much the same way they
-would build any other object-oriented Python program. This results in smaller
-source code developed in less time.
-
-CherryPy does its best to stay out of the way between the programmer and the
-problem. It works out of the box; default behavior is sensible enough to allow
-use without extensive setup or customization. However, its :doc:`configuration </tutorial/config>`
-and :doc:`plugin </progguide/extending/customplugins>` systems are more than enough to easily build and deploy complex
-sites.
-
-You are free to use any kind of templating, data access etc. technology
-you want. CherryPy also has built-in tools for
-:doc:`sessions </refman/lib/sessions>`,
-:doc:`static files </progguide/files/static>`,
-:doc:`cookies </progguide/cookies>`,
-:doc:`file uploads </progguide/files/uploading>`,
-:doc:`caching </refman/lib/caching>`, :doc:`encoding </refman/lib/encoding>`,
-:doc:`authorization </refman/lib/auth_basic>`,
-:doc:`compression </refman/lib/encoding>`,
-and :doc:`many more </tutorial/tools>`.
-
-The production-ready, HTTP/1.1-compliant web server allows you to deploy
-web applications anywhere Python is installed. It also supports any other
-WSGI-enabled webserver or adapter, including Apache, IIS, lighttpd, mod_python,
-FastCGI, SCGI, and mod_wsgi, even multiple ones. And it's *fast*; typically,
-CherryPy itself takes only 1-2ms per request! It is being used in production
-by many sites, from the simplest to the most demanding.
-
-CherryPy applications run on Windows, Linux, Mac OS X and any other platform
-supporting Python 2.3 or higher.
-
-CherryPy is now more than eight years old and it is has proven very fast and
-stable. It is well tested, and includes tools for testing, profiling, and
-coverage of your own applications.
-
-Oh, and most importantly: CherryPy is fun to work with :-)
-Here's how easy it is to write "Hello World" in CherryPy::
-
- import cherrypy
-
- class HelloWorld(object):
- def index(self):
- return "Hello World!"
- index.exposed = True
-
- cherrypy.quickstart(HelloWorld())
-
-
-What CherryPy is NOT?
-=====================
-
-As an HTTP framework, CherryPy does all that is necessary to allow Python code
-to be executed when some resource (URL) is requested by the user. However:
-
- * CherryPy is not a templating language, such as PHP. CherryPy can work with
- several Python templating packages (see :doc:`/progguide/choosingtemplate`),
- but does not ship one by default.
- * CherryPy does not fill out HTML forms for you. You're free to use formencode
- or any other solution, or none at all if you're not using HTML ;)
- * CherryPy is not a database or ORM. Rather than dictate or bless a persistence
- layer to you, CherryPy allows you to choose your own.
-
-
-Contents
-========
-
-.. toctree::
- :maxdepth: 3
- :glob:
-
- whycherrypy
- install
- license
-
-
diff --git a/sphinx/source/intro/install.rst b/sphinx/source/intro/install.rst
deleted file mode 100644
index 51f59cbb..00000000
--- a/sphinx/source/intro/install.rst
+++ /dev/null
@@ -1,109 +0,0 @@
-************
-Installation
-************
-
-:ref:`prerequisites`
-
-:ref:`stableversions`
-
-:ref:`developmentversions`
-
-.. _prerequisites:
-
-Prerequisites
-=============
-
-All you need is a working version of Python-2.3 or later on your computer.
-If you are running Max OS X or some Linux distribution (e.g. Ubuntu, Debian, Fedora)
-you most likely already have python on you system, for a detailed instruction
-on how to install python follow the instruction on the
-`python wiki <http://wiki.python.org/moin/BeginnersGuide/Download>`_.
-
-.. _stableversions:
-
-Download Stable Versions
-========================
-
-Using `pip` or `easy_install`
------------------------------
-
-Using pip::
-
- $ pip install CherryPy
-
-or with easy_install::
-
- $ easy_install CherryPy
-
-It is recommended to use `pip` instead of `easy_install`.
-If you want to download and install CherryPy for yourself proceed to the
-next instructions depending on your platform.
-
-Unix/Mac
---------
-
-You may download the most current version from `PyPI <https://pypi.python.org/pypi/CherryPy/3.2.3>`_
-
-For other releases, browse our
-`download index <http://download.cherrypy.org/cherrypy>`_.
-
-* Unzip/untar the files
-* Enter the directory created by the file extraction.
-* Type "python setup.py install" to install the CherryPy module
-
-
-Windows
--------
-
-You may download the most current version from `PyPI <https://pypi.python.org/pypi/CherryPy/3.2.3>`_.
-
-For other releases, browse our `download index <http://download.cherrypy.org/cherrypy>`_.
-
-* Select the file ending in ".exe".
-* Run the downloaded file.
-
-
-Next Steps
-==========
-
-To run your first sample website:
-
- 1. In a command terminal or console go to cherrypy/tutorial/
- 2. Type::
-
- $ python tut01_helloworld.py
-
- and you'll have a running website on port 8080.
-
- 3. Open your favorite browser and point it to http://localhost:8080 to see your first CherryPy-served page :-)
-
-Now, you should try running some of the other tutorials found in the tutorial
-directory and look at their source code to understand how to develop a website
-with CherryPy.
-
-.. _developmentversions:
-
-Development versions
-====================
-
-CherryPy's source code is managed using `Mercurial <http://mercurial.selenic.com/>`_,
-a source code control system written in python.
-
-You can access our Mercurial repository using your favorite
-Mercurial client at `bitbucket <https://bitbucket.org/cherrypy/cherrypy>`_.
-
-For Windows users, we recommend the wonderful Mercurial
-client `TortoiseHg <http://tortoisehg.org/>`_. Users of
-other operating systems are advised to use multi-platform
-command line tools provided by the
-`core Mercurial distribution <http://mercurial.selenic.com/downloads/>`_.
-
-* To submit a patch: fork the repository and submit your pull request.
- For further information please contact us via email or IRC
- (see `getting involved <http://bitbucket.org/cherrypy/cherrypy/wiki/CherryPyInvolved>`_).
-
-Standalone WSGI server
-----------------------
-
-The WSGI server that comes bundled with CherryPy is available as a standalone
-module. Feel free to use it for all of your WSGI serving needs.
diff --git a/sphinx/source/intro/license.rst b/sphinx/source/intro/license.rst
deleted file mode 100644
index 86125af4..00000000
--- a/sphinx/source/intro/license.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-**********************
-CherryPy License (BSD)
-**********************
-
-::
-
- Copyright (c) 2002-2013, CherryPy Team (team@cherrypy.org)
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without modification,
- are permitted provided that the following conditions are met:
-
- * Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
- * Neither the name of the CherryPy Team nor the names of its contributors
- may be used to endorse or promote products derived from this software
- without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
diff --git a/sphinx/source/intro/whycherrypy.rst b/sphinx/source/intro/whycherrypy.rst
deleted file mode 100644
index ffbcd0c7..00000000
--- a/sphinx/source/intro/whycherrypy.rst
+++ /dev/null
@@ -1,105 +0,0 @@
-********************
-Why choose CherryPy?
-********************
-
-Let's face it: there are **dozens** of different Python web frameworks. Why would
-you want to choose CherryPy for your next dynamic Web project?
-
-1. Simplicity
--------------
-
-Developing with CherryPy is a simple task. "Hello, world" is only a few lines
-long, and does not require the developer to learn the entire (albeit very
-manageable) framework all at once. The framework is very pythonic; that is,
-it follows Python's conventions very nicely (code is sparse and clean).
-
-Contrast this with J2EE and Python's most popular and visible web frameworks:
-Django, Zope, Pylons, and Turbogears. In all of them, the learning curve is
-massive. In these frameworks, "Hello, world" requires the programmer to set
-up a large scaffold which spans multiple files and to type a lot of boilerplate
-code. CherryPy succeeds because it does not include the bloat of other
-frameworks, allowing the programmer to write their web application quickly
-while still maintaining a high level of organization and scalability.
-
-CherryPy is also very modular. The core is fast and clean, and extension
-features are easy to write and plug in using code or the elegant config
-system. The primary components (server, engine, request, response, etc.)
-are all extendable (even replaceable) and well-managed.
-
-In short, CherryPy empowers the developer to work with the framework,
-not against or around it.
-
-2. Power
---------
-
-CherryPy leverages all of the power of Python. Python is a dynamic language
-which allows for rapid development of applications. Python also has an
-extensive built-in API which simplifies web app development. Even more
-extensive, however, are the third-party libraries available for Python. These
-range from object-relational mappers to form libraries, to an automatic Python
-optimizer, a Windows exe generator, imaging libraries, email support, HTML
-templating engines, etc. CherryPy applications are just like regular Python
-applications. CherryPy does not stand in your way if you want to use these
-brilliant tools.
-
-CherryPy also provides :doc:`Tools </tutorial/tools>` and
-:doc:`Plugins </progguide/extending/customplugins>`, which are powerful
-extension points needed to develop world-class web applications.
-
-3. Maturity
------------
-
-Maturity is extremely important when developing a real-world application.
-Unlike many other web frameworks, CherryPy has had many final, stable releases.
-It is fully bugtested, optimized, and proven reliable for real-world use.
-The API will not suddenly change and break backwards compatibility, so your
-applications are assured to continue working even through subsequent updates
-in the current version series.
-
-CherryPy is also a "3.0" project: the first edition of CherryPy set the tone,
-the second edition made it work, and the third edition makes it beautiful.
-Each version built on lessons learned from the previous, bringing the developer
-a superior tool for the job.
-
-4. Community
-------------
-
-CherryPy has an active community that develops deployed CherryPy applications
-and are willing and ready to assist you on the
-`CherryPy mailing list <http://groups.google.com/group/cherrypy-users>`_ or
-IRC (#cherrypy on `OFTC <http://www.oftc.net/oftc/>`_).
-The developers also frequent the list and often answer questions and implement
-features requested by the end-users.
-
-5. Deployability
-----------------
-
-Unlike many other Python web frameworks, there are cost-effective ways to
-deploy your CherryPy application.
-
-Out of the box, CherryPy includes its own production-ready HTTP server
-to host your application. If the application needs to be deployed on Apache,
-there is copious documentation discussing how to connect the two. CherryPy can
-also be deployed on any WSGI-compliant gateway (a technology for interfacing
-numerous types of web servers): mod_wsgi, FastCGI, SCGI, IIS, etc.
-
-In addition, CherryPy is pure-python and is compatible with Python 2.3. This
-means that CherryPy will run on all major platforms that Python will run on
-(Windows, MacOSX, Linux, BSD, etc).
-
-`Webfaction.com <http://www.webfaction.com>`_, run by the inventor of CherryPy,
-is a commercial web host that offers CherryPy hosting packages (in addition to
-several others).
-
-6. It's free!
--------------
-
-:doc:`All of CherryPy is licensed </intro/license>` under the open-source BSD license, which means
-**CherryPy can be used commercially for ZERO cost**.
-
-7. Where to go from here?
--------------------------
-
-Check out the :doc:`/tutorial/index` and :doc:`/progguide/index` for
-more complete documentation.
-
diff --git a/sphinx/source/progguide/REST.rst b/sphinx/source/progguide/REST.rst
deleted file mode 100644
index 13cecadf..00000000
--- a/sphinx/source/progguide/REST.rst
+++ /dev/null
@@ -1,255 +0,0 @@
-*****************************************
-Creating RESTful applications in CherryPy
-*****************************************
-
-Introduction
-============
-
-REST (Representational State Transfer) is an architectural style that
-is well-suited to implementation in CherryPy. Both REST and CherryPy
-heavily leverage the HTTP protocol but otherwise carry minimal
-requisite overhead. This chapter briefly discusses the purpose of
-REST and an example implementation in CherryPy.
-
-REST in a nutshell
-==================
-
-The REST architectural style describes how domain models and their state
-are referenced and transferred. The primary goal of REST is promote
-certain advantageous qualities of a distributed system, namely high
-visibility, scalability, extensibility.
-
-Terminology
------------
-
- - "resources" are concepual objects represented by the system - any
- information that can be named is a resource.
- - "state" is data held by or associated with resources
- - "representations" are information in state with a specific encoding
- - "methods" are invoked to transfer or mutate state.
- - an "identifier" is a URL or URI which uniquely and usually globally
- references a resource.
-
-More information on REST can be found in abundance in Wikipedia and
-other readily-available resources.
-
-Implementing REST in CherryPy
-=============================
-
-From the canonical `Roy Fielding dissertation <http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm#sec_5_1_5>`_ :
-
- REST is defined by four interface constraints: identification of resources;
- manipulation of resources through representations; self-descriptive messages;
- and, hypermedia as the engine of application state
-
-This section covers each of these four contstraints and demonstrates how each
-is applied in a CherryPy implementation.
-
-Identification of Resources
----------------------------
-
-As an HTTP service provider, resources represented in CherryPy are
-referenced by HTTP URIs (Uniform Resource Identifiers). A URI consists
-of four parts: scheme, hierarchical identifier, query, and fragment.
-For HTTP, the scheme is always ``http`` or ``https``. The hierarchical
-identifier consists of an authority (typically host/port) and a path
-(similar to a file system path, but not necessarily representing an
-actual path).
-
-A single CherryPy instance is typically bound to a single
-server/port pair, such that the scheme://authority portion of the URI
-references the server. This aspect is configured through the
-``server.socket_host`` and ``server.socket_port`` options or via another
-hosting server.
-
-Within the CherryPy server, the remainder of the hierarchical
-identifier--the path--is mapped to Python objects
-via the Dispatch mechanism. This behavior is highly
-customizable and documented in :doc:`/tutorial/dispatching`.
-
-Using the default dispatcher and page handlers, the path of the URI
-maps to a hierarchy of Python identifiers in the CherryPy app. For
-example, the URI path ``/container/objects/pencil`` will result in a
-call to ``app.root.container.objects.pencil()`` where ``app`` is the
-CherryPy app.
-
-Manipulation of Resources Through Representations
--------------------------------------------------
-
-REST defines the use of the HTTP protocol and HTTP methods to implement
-the standard REST methods.
-
- - GET retrieves the state of a specific resource,
- - PUT creates or replaces the state of a specific resource,
- - POST passes information to a resource to use at it sees fit,
- - DELETE removes resources.
-
-The default dispatcher in CherryPy stores the HTTP method name at
-:attr:`cherrypy.request.method<cherrypy._cprequest.Request.method>`.
-
-Because HTTP defines these invocation methods, the most direct
-way to implement REST using CherryPy is to utilize the
-:class:`MethodDispatcher<cherrypy._cpdispatch.MethodDispatcher>`
-instead of the default dispatcher. To enable
-the method dispatcher, add the
-following to your configuration for the root URI ("/")::
-
- '/': {
- 'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
- }
-
-Now, the REST methods will map directly to the same method names on
-your resources. That is, a GET method on a CherryPy class implements
-the HTTP GET on the resource represented by that class.
-
-For example::
-
- class Resource(object):
-
- exposed = True
-
- def GET(self):
- return """Some representation of self"""
-
- def PUT(self):
- self.content = initialize_from_representation(cherrypy.request.body.read())
-
-The concrete implementation of GET and PUT has been omitted, but the
-basic concepts remain: GET returns some meaningful representation of
-the resource and PUT stores an instance of an object represented by the
-content in the body of the request.
-
-Self-Descriptive Messages
--------------------------
-
-REST enables powerful clients and intermediaries by requiring messages to be
-self-descriptive; that is, everything you need to know about a message is
-carried within the message itself, either in headers or within the definition
-of the message's declared media type.
-
-CherryPy gives you easy access to the headers. It's as simple as
-:attr:`cherrypy.request.headers<cherrypy._cprequest.Request.headers>` and
-:attr:`cherrypy.response.headers<cherrypy._cprequest.Response.headers>`!
-Each is a normal Python dictionary which you can read and write as you like.
-They also have additional functions to help you parse complex values according
-to the HTTP spec.
-
-CherryPy also allows you to set whatever response Content-Type you prefer,
-just like any other response header. You have complete control. When reading
-request entities, you can register :ref:`custombodyprocessors` for different
-media types.
-
-Hypermedia as the Engine of Application State
----------------------------------------------
-
-REST is designed as a stateless protocol--all application state is
-maintained with the application at the client. Thus, concepts such as a
-"session" need not be maintained by the server. CherryPy does not enable
-sessions by default, so it is well-suited to the RESTful style.
-
-In order for the client to maintain meaningful state, however, the REST
-server implementer must provide meaningful URIs which supply semantic
-links between resources.
-
-For example, a CherryPy application might have a resource index, which
-a client might retrieve to inspect the application for other resources::
-
- class ResourceIndex(object):
- def GET(self):
- items = [item.get_href() for item in self.get_all_items()]
- return ', '.join(items)
-
-This very simple example demonstrates how to create an index of
-comma-separated hypertext references. This example assumes the client
-can effectively interpret comma-separated references. In practice,
-another representation such as HTML or JSON might be used.
-
-A Quick Example
-===============
-
-For example, consider the following contrived REST+HTML specification.
-
-1. Resources store arbitrary key/value pairs with unique keys
- (represented as a Python dict).
-
-2. A GET request returns colon-separated key/value pairs in ``<div>``
- elements.
-
-3. A PUT request accepts colon-separated key/value pairs in ``<div>``
- elements.
-
-4. An index resource provides an HTML anchor tag (hypertext link) to objects
- which it indexes (where the keys represent the names and the values
- represent the link).
-
-A REST+HTML implementation was chosen for this example as HTML defines
-relative links, which keeps the example simple yet functional.
-
-Complete Example
-----------------
-
-Brining the above code samples together and adding some basic
-configuration results in the following program, which can be run
-directly::
-
- import cherrypy
-
- class Resource(object):
-
- def __init__(self, content):
- self.content = content
-
- exposed = True
-
- def GET(self):
- return self.to_html()
-
- def PUT(self):
- self.content = self.from_html(cherrypy.request.body.read())
-
- def to_html(self):
- html_item = lambda (name,value): '<div>{name}:{value}</div>'.format(\*\*vars())
- items = map(html_item, self.content.items())
- items = ''.join(items)
- return '<html>{items}</html>'.format(**vars())
-
- @staticmethod
- def from_html(data):
- pattern = re.compile(r'\<div\>(?P<name>.*?)\:(?P<value>.*?)\</div\>')
- items = [match.groups() for match in pattern.finditer(data)]
- return dict(items)
-
- class ResourceIndex(Resource):
- def to_html(self):
- html_item = lambda (name,value): '<div><a href="{value}">{name}</a></div>'.format(\*\*vars())
- items = map(html_item, self.content.items())
- items = ''.join(items)
- return '<html>{items}</html>'.format(**vars())
-
- class Root(object):
- pass
-
- root = Root()
-
- root.sidewinder = Resource({'color': 'red', 'weight': 176, 'type': 'stable'})
- root.teebird = Resource({'color': 'green', 'weight': 173, 'type': 'overstable'})
- root.blowfly = Resource({'color': 'purple', 'weight': 169, 'type': 'putter'})
- root.resource_index = ResourceIndex({'sidewinder': 'sidewinder', 'teebird': 'teebird', 'blowfly': 'blowfly'})
-
- conf = {
- 'global': {
- 'server.socket_host': '0.0.0.0',
- 'server.socket_port': 8000,
- },
- '/': {
- 'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
- }
- }
-
- cherrypy.quickstart(root, '/', conf)
-
-Conclusion
-==========
-
-CherryPy provides a straightforward interface for readily creating
-RESTful interfaces.
diff --git a/sphinx/source/progguide/choosingtemplate.rst b/sphinx/source/progguide/choosingtemplate.rst
deleted file mode 100644
index 8cfd5631..00000000
--- a/sphinx/source/progguide/choosingtemplate.rst
+++ /dev/null
@@ -1,151 +0,0 @@
-******************************
-Choosing a templating language
-******************************
-
-CherryPy is an open-ended HTTP framework that integrates with a wide variety of
-templating systems. So the first point we want to make is that you should do
-your own study *with your own data* to find out which one is best for you.
-
-That said, we recommend you start with one of these three:
-
-`Mako <http://www.makotemplates.org/>`_
-=======================================
-
-Mako is a template library written in Python. It provides a familiar, non-XML
-syntax which compiles into Python modules for maximum performance. Mako's syntax
-and API borrows from the best ideas of many others, including Django templates,
-Cheetah, Myghty, and Genshi. Conceptually, Mako is an embedded Python (i.e.
-Python Server Page) language, which refines the familiar ideas of componentized
-layout and inheritance to produce one of the most straightforward and flexible
-models available, while also maintaining close ties to Python calling and
-scoping semantics.
-
-Mako snippet::
-
- <table>
- % for row in rows:
- ${makerow(row)}
- % endfor
- </table>
-
-
-CherryPy integration example::
-
- import cherrypy
- from mako.template import Template
- from mako.lookup import TemplateLookup
- lookup = TemplateLookup(directories=['html'])
-
- class Root:
- @cherrypy.expose
- def index(self):
- tmpl = lookup.get_template("index.html")
- return tmpl.render(salutation="Hello", target="World")
-
-
-`Jinja2 <http://jinja.pocoo.org/2/>`_
-=====================================
-
-Jinja2 is a library for Python 2.4 and onwards that is designed to be flexible,
-fast and secure. If you have any exposure to other text-based template languages,
-such as Smarty or Django, you should feel right at home with Jinja2. It’s both
-designer and developer friendly by sticking to Python’s principles and adding
-functionality useful for templating environments.
-
-The key-features are...
-
- * ... configurable syntax. If you are generating LaTeX or other formats with
- Jinja2 you can change the delimiters to something that integrates better
- into the LaTeX markup.
- * ... fast. While performance is not the primarily target of Jinja2 it’s
- surprisingly fast. The overhead compared to regular Python code was reduced
- to the very minimum.
- * ... easy to debug. Jinja2 integrates directly into the python traceback
- system which allows you to debug Jinja2 templates with regular python
- debugging helpers.
- * ... secure. It’s possible to evaluate untrusted template code if the optional
- sandbox is enabled. This allows Jinja2 to be used as templating language for
- applications where users may modify the template design.
-
-Jinja2 snippet::
-
- <ul id="navigation">
- {% for item in navigation %}
- <li><a href="{{ item.href }}">{{ item.caption }}</a></li>
- {% endfor %}
- </ul>
-
-
-CherryPy integration example::
-
- import cherrypy
- from jinja2 import Environment, FileSystemLoader
- env = Environment(loader=FileSystemLoader('templates'))
-
- class Root:
- @cherrypy.expose
- def index(self):
- tmpl = env.get_template('index.html')
- return tmpl.render(salutation='Hello', target='World')
-
-
-`Genshi <http://genshi.edgewall.org>`_
-=======================================
-
-Genshi is a Python library that provides an integrated set of components for
-parsing, generating, and processing HTML, XML or other textual content for
-output generation on the web.
-
-The main feature is a template language that is smart about markup: unlike
-conventional template languages that only deal with bytes and (if you're lucky)
-characters, Genshi knows the difference between tags, attributes, and actual
-text nodes, and uses that knowledge to your advantage.
-
-Plain XHTML templates make Genshi easy to use even for web designers who don't
-know Python. Do you know XHTML? Then you're 75% of the way there! It's
-considered by many to be the successor to Kid.
-
-See the `Genshi tutorial <http://tools.cherrypy.org/wiki/Genshi>`_.
-
-Because it parses HTML/XML, it can be slower than other solutions.
-See `Genshi performance <http://genshi.edgewall.org/wiki/GenshiPerformance>`_
-for more information.
-
-Genshi snippet::
-
- <ol py:if="links">
- <li py:for="link in links">
- <a href="${link.url}">${link.title}</a>
- posted by ${link.username} at ${link.time.strftime('%x %X')}
- </li>
- </ol>
-
-CherryPy integration example::
-
- import cherrypy
- from genshi.template import TemplateLoader
- loader = TemplateLoader('/path/to/templates', auto_reload=True)
-
- class Root:
- @cherrypy.expose
- def index(self):
- tmpl = loader.load('index.html')
- page = tmpl.generate(salutation='Hello', target='World')
- return page.render('html', doctype='html')
-
-
-Others
-======
-
- * Cheetah
- * ClearSilver
- * Kid
- * HTMLTemplate
- * Nevow
- * PSP
- * PyMeld
- * py.xml
- * XSLT
- * Xyaptu
- * ZPT
-
diff --git a/sphinx/source/progguide/cookies.rst b/sphinx/source/progguide/cookies.rst
deleted file mode 100644
index afb218ab..00000000
--- a/sphinx/source/progguide/cookies.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-********************************
-How to use cookies with CherryPy
-********************************
-
-CherryPy uses the :mod:`Cookie` module from python and in particular the
-:class:`Cookie.SimpleCookie` object type to handle cookies.
-
-* To send a cookie to a browser, set ``cherrypy.response.cookie[key] = value``.
-* To retrieve a cookie sent by a browser, use ``cherrypy.request.cookie[key]``.
-* To delete a cookie (on the client side), you must *send* the cookie with its
- expiration time set to 0::
-
-
- cherrypy.response.cookie[key] = value
- cherrypy.response.cookie[key]['expires'] = 0
-
-
-It's important to understand that the request cookies are **not** automatically
-copied to the response cookies. Clients will send the same cookies on every
-request, and therefore ``cherrypy.request.cookie`` should be populated each
-time. But the server doesn't need to send the same cookies with every response;
-therefore, **``cherrypy.response.cookie`` will usually be empty**. When you wish
-to "delete" (expire) a cookie, therefore, you must set
-``cherrypy.response.cookie[key] = value`` first, and then set its ``expires``
-attribute to 0.
-
-Extended example::
-
- import cherrypy
-
- class Root:
- def setCookie(self):
- cookie = cherrypy.response.cookie
- cookie['cookieName'] = 'cookieValue'
- cookie['cookieName']['path'] = '/'
- cookie['cookieName']['max-age'] = 3600
- cookie['cookieName']['version'] = 1
- return "<html><body>Hello, I just sent you a cookie</body></html>"
- setCookie.exposed = True
-
- def readCookie(self):
- cookie = cherrypy.request.cookie
- res = """<html><body>Hi, you sent me %s cookies.<br />
- Here is a list of cookie names/values:<br />""" % len(cookie)
- for name in cookie.keys():
- res += "name: %s, value: %s<br>" % (name, cookie[name].value)
- return res + "</body></html>"
- readCookie.exposed = True
-
- cherrypy.quickstart(Root())
-
diff --git a/sphinx/source/progguide/customheaders.rst b/sphinx/source/progguide/customheaders.rst
deleted file mode 100644
index 1b1a6f80..00000000
--- a/sphinx/source/progguide/customheaders.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-
-Custom Response Headers
-***********************
-
-Although the ``cherrypy.response.headers`` is usually adequate for
-supplying headers in a CherryPy response, it is sometimes desirable for
-the server application to customize the order of the resultant headers
-or provide multiple headers with duplicate keys. This section describes
-how one can accomplish these tasks within the CherryPy framework.
-
-Process
-=======
-
-The CherryPy Response object maintains a dictionary of headers until the
-finalize phase, after which the headers in the dictionary are converted
-into a list of (name, value) tuples. See
-``cherrypy._cprequest.Response`` for details.
-
-Therefore, since a dictionary discards order and duplicate keys,
-customizing the order or duplicity of keys must occur after the finalize
-phase.
-
-This end can be effected using a tool bound to the ``on_end_resource``
-hook.
-
-Multiple Headers
-================
-
-The following example illustrates the creation of a multiheaders tool to
-deliver multiple headers with the same key in the response.
-
-::
-
- #python
- import cherrypy
-
- def multi_headers():
- cherrypy.response.header_list.extend(
- cherrypy.response.headers.encode_header_items(
- cherrypy.response.multiheaders))
-
- cherrypy.tools.multiheaders = cherrypy.Tool('on_end_resource', multi_headers)
-
- class Root(object):
- @cherrypy.expose
- @cherrypy.tools.multiheaders()
- def index(self):
- cherrypy.response.multiheaders = [('foo', '1'), ('foo', '2')]
- return "Hello"
-
- cherrypy.quickstart(Root())
-
-Header Order
-============
-
-The following example illustrates the creation of a firstheaders tool to
-deliver headers in a specified order (at the beginning) in the response.
-
-::
-
- #python
- import cherrypy
-
- def first_headers():
- cherrypy.response.header_list[:0] = cherrypy.response.first_headers
-
- cherrypy.tools.firstheaders = cherrypy.Tool('on_end_resource', first_headers)
-
- class Root(object):
- @cherrypy.expose
- @cherrypy.tools.firstheaders()
- def index(self):
- cherrypy.response.first_headers = [('foo', '1'), ('foo', '2')]
- return "Hello"
-
- cherrypy.quickstart(Root())
diff --git a/sphinx/source/progguide/extending/customplugins.rst b/sphinx/source/progguide/extending/customplugins.rst
deleted file mode 100644
index 609f5c59..00000000
--- a/sphinx/source/progguide/extending/customplugins.rst
+++ /dev/null
@@ -1,131 +0,0 @@
-**************
-Custom Plugins
-**************
-
-CherryPy allows you to extend startup, shutdown, and other behavior outside the
-request process via *Listeners* and *Plugins*. The
-:class:`cherrypy.engine<cherrypy.process.wspbus.Bus>` object controls
-these behaviors; to extend them, you subscribe listeners to the engine.
-These allow you to run functions at a particular point in the
-*site* process; for the *request* process, see :doc:`customtools` instead.
-
-Listeners
-=========
-
-The engine is a publish-subscribe service; event handlers publish to various
-*channels*, like "start", "stop", "exit", "graceful", or "log", and both
-CherryPy and you can subscribe *listeners* for those messages::
-
- engine.subscribe(channel, callback[, priority])
-
-channel
--------
-
-The channel is an event name:
-
- * start: the Engine is starting for the first time, or has been stopped and is
- now restarting; listeners here should start up sockets, files, or other
- services and not return until they are ready to be used by clients or
- other parts of the site.
- * stop: the Engine is stopping; plugins should cleanly stop what they are
- doing and not return until they have finished cleaning up. This is called
- by :func:`cherrypy.engine.stop<cherrypy.process.wspbus.Bus.stop>`, and
- plugins should make every effort to stop and clean up in a fashion that
- permits them to be restarted via a "start" listener.
- * graceful: advises all listeners to reload, e.g. by closing any open files
- and reopening them.
- * exit: this is called by
- :func:`cherrypy.engine.exit<cherrypy.process.wspbus.Bus.exit>`,
- and advises plugins to prepare for process termination. Note that
- :func:`cherrypy.engine.exit<cherrypy.process.wspbus.Bus.exit>` first calls
- :func:`cherrypy.engine.stop<cherrypy.process.wspbus.Bus.stop>`, so Plugins
- may expect to stop first, then exit in a separate step.
- * log(msg, level): in general, :class:`cherrypy.log<cherrypy._cplogging.LogManager>`
- listens on this channel. Plugins, however, should make every effort to
- publish to this channel verbosely to aid process event debugging. See the
- builtin Plugins for good examples.
- * main: New in 3.2. All Engine tasks run in threads other than the main thread;
- the main thread usually calls
- :func:`cherrypy.engine.block<cherrypy.process.wspbus.Bus.block>` to wait
- for KeyboardInterrupt and other signals. While blocked, it loops
- (every 1/10th of a second, by default), and publishes a message on the
- "main" channel each time. Listeners subscribed to this channel, therefore,
- are called at every interval.
-
-callback
---------
-
-The functionality you wish to run; this can be any function, class, or other
-callable. Each channel defines the arguments; currently, however, only the "log"
-channel defines any ('msg', the string message to log, and 'level', an int
-following the levels defined in the stdlib's :mod:`logging <logging>` module).
-
-priority
---------
-
-The optional priority (0 - 100) allows multiple listeners to run in the correct
-order. Lower numbers run first. The default is 50.
-
-If you omit the priority argument to engine.subscribe (or pass ``None``),
-you can instead set it as an attribute on the callback function::
-
- def setup_db():
- ....
- setup_db.priority = 90
- engine.subscribe('start', setup_db)
-
-
-Plugins
-=======
-
-You can manually subscribe bus listeners, but you probably shouldn't.
-*Plugins* allow your function to be subscribed and configured both
-via the CherryPy config system and via the Plugin itself. Plugins also allow
-you to write a single class that listens on multiple channels.
-
-Most of the built-in plugins have their own ``subscribe`` method,
-so that instead of writing ``engine.subscribe``, you write:
-``p = Plugin(engine).subscribe()``. If you want to turn off a plugin,
-call ``p.unsubscribe()``. The plugin already knows the correct channel,
-callback, and priority.
-
-You can run arbitrary code at any of the events by creating a
-SimplePlugin object, with one method for each *channel* you wish to handle::
-
- class ScratchDB(plugins.SimplePlugin):
-
- def start(self):
- self.fname = 'myapp_%d.db' % os.getpid()
- self.db = sqlite.connect(database=self.fname)
- start.priority = 80
-
- def stop(self):
- self.db.close()
- os.remove(self.fname)
- cherrypy.engine.scratchdb = ScratchDB(cherrypy.engine)
-
-...then, once you've authored your Plugin, turn it on by calling its
-``subscribe`` method::
-
- cherrypy.engine.scratchdb.subscribe()
-
-...or, in CherryPy 3.2 and above, in site config::
-
- [global]
- engine.scratchdb.on = True
-
-
-Priorities of the built-in "start" listeners:
-
-====================================================================== ================
- Listener Priority
-====================================================================== ================
- default 50
- :doc:`Daemonizer </refman/process/plugins/daemonizer>` 65
- :doc:`Timeout Monitor </progguide/responsetimeouts>` 70
- :class:`Autoreloader <cherrypy.process.plugins.Autoreloader>` 70
- :doc:`PID File </refman/process/plugins/pidfile>` 70
- :doc:`HTTP Servers </refman/process/servers>` 75
- :doc:`Drop Privileges </refman/process/plugins/dropprivileges>` 77
-====================================================================== ================
-
diff --git a/sphinx/source/progguide/extending/customtools.rst b/sphinx/source/progguide/extending/customtools.rst
deleted file mode 100644
index b4d22336..00000000
--- a/sphinx/source/progguide/extending/customtools.rst
+++ /dev/null
@@ -1,282 +0,0 @@
-************
-Custom Tools
-************
-
-CherryPy is an extremely capable platform for web application and framework
-development. One of the strengths of CherryPy is its modular design; CherryPy
-separates key-but-not-core functionality out into "tools". This provides two
-benefits: a slimmer, faster core system and a supported means of tying
-additional functionality into the framework.
-
-Tools can be enabled for any point of your CherryPy application: a certain
-path, a certain class, or even individual methods using the
-:ref:`_cp_config <cp_config>` dictionary. Tools can also be used as decorators
-which provide syntactic sugar for configuring a tool for a specific callable.
-See :doc:`/tutorial/tools` for more information on how to use Tools.
-This document will show you how to make your own.
-
-Your First Custom Tool
-======================
-
-Let's look at a very simple authorization tool::
-
- import cherrypy
-
- def protect(users):
- if cherrypy.request.login not in users:
- raise cherrypy.HTTPError("401 Unauthorized")
-
- cherrypy.tools.protect = Tool('on_start_resource', protect)
-
-We can now enable it in the standard ways: a config file or dict passed to an
-application, a :ref:`_cp_config<cp_config>` dict on a particular class or
-callable or via use of the tool as a decorator. Here's how to turn it on in
-a config file::
-
- [/path/to/protected/resource]
- tools.protect.on = True
- tools.protect.users = ['me', 'myself', 'I']
-
-Now let's look at the example tool a bit more closely.
-Working from the bottom up, the :class:`cherrypy.Tool<cherrypy._cptools.Tool>`
-constructor takes 2 required and 2 optional arguments.
-
-point
------
-
-First, we need to declare the point in the CherryPy request/response
-handling process where we want our tool to be triggered. Different request
-attributes are obtained and set at different points in the request process.
-In this example, we'll run at the first *hook point*, called "on_start_resource".
-
-.. _hooks:
-
-Hooks
-^^^^^
-
-Tools package up *hooks*. When we created a Tool instance above, the Tool
-class registered our `protect` function to run at the 'on_start_resource'
-*hookpoint*. You can write code that runs at hookpoints without using a Tool
-to help you, but you probably shouldn't. The Tool system allows your function
-to be turned on and configured both via the CherryPy config system and via the
-Tool itself as a decorator. You can also write a Tool that runs code at multiple
-hook points.
-
-Here is a quick rundown of the "hook points" that you can hang your tools on:
-
- * on_start_resource - The earliest hook; the Request-Line and request headers
- have been processed and a dispatcher has set request.handler and request.config.
- * before_request_body - Tools that are hooked up here run right before the
- request body would be processed.
- * before_handler - Right before the request.handler (the "exposed" callable
- that was found by the dispatcher) is called.
- * before_finalize - This hook is called right after the page handler has been
- processed and before CherryPy formats the final response object. It helps
- you for example to check for what could have been returned by your page
- handler and change some headers if needed.
- * on_end_resource - Processing is complete - the response is ready to be
- returned. This doesn't always mean that the request.handler (the exposed
- page handler) has executed! It may be a generator. If your tool absolutely
- needs to run after the page handler has produced the response body, you
- need to either use on_end_request instead, or wrap the response.body in a
- generator which applies your tool as the response body is being generated
- (what a mouthful--see
- `caching tee.output <http://www.cherrypy.org/browser/trunk/cherrypy/lib/caching.py>`_
- for an example).
- * before_error_response - Called right before an error response
- (status code, body) is set.
- * after_error_response - Called right after the error response
- (status code, body) is set and just before the error response is finalized.
- * on_end_request - The request/response conversation is over, all data has
- been written to the client, nothing more to see here, move along.
-
-
-callable
---------
-
-Second, we need to provide the function that will be called back at that
-hook point. Here, we provide our ``protect`` callable. The Tool
-class will find all config entries related to our tool and pass them as
-keyword arguments to our callback. Thus, if::
-
- 'tools.protect.on' = True
- 'tools.protect.users' = ['me', 'myself', 'I']
-
-is set in the config, the users list will get passed to the Tool's callable.
-[The 'on' config entry is special; it's never passed as a keyword argument.]
-
-The tool can also be invoked as a decorator like this::
-
- @cherrypy.expose
- @cherrypy.tools.protect(users=['me', 'myself', 'I'])
- def resource(self):
- return "Hello, %s!" % cherrypy.request.login
-
-name
-----
-
-This argument is optional as long as you set the Tool onto a Toolbox. That is::
-
-
- def foo():
- cherrypy.request.foo = True
- cherrypy.tools.TOOLNAME = cherrypy.Tool('on_start_resource', foo)
-
-The above will set the 'name' arg for you (to 'TOOLNAME'). The only time you
-would need to provide this argument is if you're bypassing the toolbox in some way.
-
-priority
---------
-
-This specifies a priority order (from 0 - 100) that determines the order in
-which callbacks in the same hook point are called. The lower the priority
-number, the sooner it will run (that is, we call .sort(priority) on the list).
-The default priority for a tool is set to 50 and most built-in tools use that
-default value.
-
-Custom Toolboxes
-================
-
-All of the builtin CherryPy tools are collected into a Toolbox called
-:attr:`cherrypy.tools`. It responds to config entries in the "tools"
-:ref:`namespace<namespaces>`. You can add your own Tools to this Toolbox
-as described above.
-
-You can also make your own Toolboxes if you need more modularity. For example,
-you might create multiple Tools for working with JSON, or you might publish
-a set of Tools covering authentication and authorization from which everyone
-could benefit (hint, hint). Creating a new Toolbox is as simple as::
-
- # cpstuff/newauth.py
- import cherrypy
-
- # Create a new Toolbox.
- newauthtools = cherrypy._cptools.Toolbox("newauth")
-
- # Add a Tool to our new Toolbox.
- def check_access(default=False):
- if not getattr(cherrypy.request, "userid", default):
- raise cherrypy.HTTPError(401)
- newauthtools.check_access = cherrypy.Tool('before_request_body', check_access)
-
-Then, in your application, use it just like you would use ``cherrypy.tools``,
-with the additional step of registering your toolbox with your app.
-Note that doing so automatically registers the "newauth" config namespace;
-you can see the config entries in action below::
-
- import cherrypy
- from cpstuff import newauth
-
-
- class Root(object):
- def default(self):
- return "Hello"
- default.exposed = True
-
- conf = {'/demo': {
- 'newauth.check_access.on': True,
- 'newauth.check_access.default': True,
- }}
-
- app = cherrypy.tree.mount(Root(), config=conf)
- if hasattr(app, 'toolboxes'):
- # CherryPy 3.1+
- app.toolboxes['newauth'] = newauth.newauthtools
-
-Just the Beginning
-==================
-
-Hopefully that information is enough to get you up and running and create some
-simple but useful CherryPy tools. Much more than what you have seen in this
-tutorial is possible. Also, remember to take advantage of the fact that CherryPy
-is open source! Check out :doc:`/progguide/builtintools` and the
-:doc:`libraries</refman/lib/index>` that they are built upon.
-
-In closing, here is a slightly more complicated tool that acts as a
-"traffic meter" and triggers a callback if a certain traffic threshold is
-exceeded within a certain time frame. It should probably launch its own
-watchdog thread that actually checks the log and triggers the alerts rather
-than waiting on a request to do so, but I wanted to
-keep it simple for the purpose of example::
-
- # traffictool.py
- import time
-
- import cherrypy
-
-
- class TrafficAlert(cherrypy.Tool):
-
- def __init__(self, listclass=list):
- """Initialize the TrafficAlert Tool with the given listclass."""
-
- # A ring buffer subclass of list would probably be a more robust
- # choice than a standard Python list.
-
- self._point = "on_start_resource"
- self._name = None
- self._priority = 50
- # set the args of self.callable as attributes on self
- self._setargs()
- # a log for storing our per-path traffic data
- self._log = {}
- # a history of the last alert for a given path
- self._history = {}
- self.__doc__ = self.callable.__doc__
- self._struct = listclass
-
- def log_hit(self, path):
- """Log the time of a hit to a unique sublog for the path."""
- log = self._log.setdefault(path, self._struct())
- log.append(time.time())
-
- def last_alert(self, path):
- """Returns the time of the last alert for path."""
- return self._history.get(path, 0)
-
- def check_alert(self, path, window, threshhold, delay, callback=None):
- # set the bar
- now = time.time()
- bar = now - window
- hits = [t for t in self._log[path] if t > bar]
- num_hits = len(hits)
- if num_hits > threshhold:
- if self.last_alert(path) + delay < now:
- self._history[path] = now
- if callback:
- callback(path, window, threshhold, num_hits)
- else:
- msg = '%s - %s hits within the last %s seconds.'
- msg = msg % (path, num_hits, window)
- cherrypy.log.error(msg, 'TRAFFIC')
-
- def callable(self, window=60, threshhold=100, delay=30, callback=None):
- """Alert when traffic thresholds are exceeded.
-
- window: the time frame within which the threshhold applies
- threshhold: the number of hits within the window that will trigger
- an alert
- delay: the delay between alerts
- callback: a callback that accepts(path, window, threshhold, num_hits)
- """
-
- path = cherrypy.request.path_info
- self.log_hit(path)
- self.check_alert(path, window, threshhold, delay, callback)
-
-
- cherrypy.tools.traffic_alert = TrafficAlert()
-
- if __name__ == '__main__':
- class Root(object):
- @cherrypy.expose
- def index(self):
- return "Hi!!"
-
- @cherrypy.expose
- @cherrypy.tools.traffic_alert(threshhold=5)
- def popular(self):
- return "A popular page."
-
- cherrypy.quickstart(Root())
-
diff --git a/sphinx/source/progguide/extending/index.rst b/sphinx/source/progguide/extending/index.rst
deleted file mode 100644
index dd5fac54..00000000
--- a/sphinx/source/progguide/extending/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-******************
-Extending CherryPy
-******************
-
-If you need to perform some work that doesn't fit in a page handler, there are
-two ways to do it depending on the scope of the task. If your code needs to run
-on each request, or for only some URL's in your application, use a Tool. If your
-code needs to run elsewhere, such as process start/stop/restart/exit, or thread
-start/stop, use an Engine Plugin.
-
-.. toctree::
-
- customtools
- customplugins
-
diff --git a/sphinx/source/progguide/files/downloading.rst b/sphinx/source/progguide/files/downloading.rst
deleted file mode 100644
index d431134a..00000000
--- a/sphinx/source/progguide/files/downloading.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-*****************
-Downloading files
-*****************
-
-CherryPy allows you to serve a file from your page handler. Here is a simple recipe to handle downloads::
-
-
- #!python
- import glob
- import os.path
-
- import cherrypy
- from cherrypy.lib.static import serve_file
-
-
- class Root:
- def index(self, directory="."):
- html = """<html><body><h2>Here are the files in the selected directory:</h2>
- <a href="index?directory=%s">Up</a><br />
- """ % os.path.dirname(os.path.abspath(directory))
-
- for filename in glob.glob(directory + '/*'):
- absPath = os.path.abspath(filename)
- if os.path.isdir(absPath):
- html += '<a href="/index?directory=' + absPath + '">' + os.path.basename(filename) + "</a> <br />"
- else:
- html += '<a href="/download/?filepath=' + absPath + '">' + os.path.basename(filename) + "</a> <br />"
-
- html += """</body></html>"""
- return html
- index.exposed = True
-
- class Download:
-
- def index(self, filepath):
- return serve_file(filepath, "application/x-download", "attachment")
- index.exposed = True
-
- if __name__ == '__main__':
- root = Root()
- root.download = Download()
- cherrypy.quickstart(root)
-
-
-Note that `CherryPy <http://www.cherrypy.org/wiki/CherryPy>`_ is not the fastest for doing such things. If you think you'll have many and big downloads, put CP `BehindApache <http://www.cherrypy.org/wiki/BehindApache>`_ and let Apache serve those files.
-
-
-
-
-
diff --git a/sphinx/source/progguide/files/favicon.rst b/sphinx/source/progguide/files/favicon.rst
deleted file mode 100644
index b5ffa986..00000000
--- a/sphinx/source/progguide/files/favicon.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-*************************
-Serving the favorite icon
-*************************
-
-By default, CherryPy 3 adds a "favicon_ico" handler method to any root object
-which is mounted at "/". This is a staticfile handler, which grabs the
-favicon.ico shipped in the CherryPy distribution.
-
-To configure CherryPy to look in another file location, you can, in your server
-configuration, do the following::
-
- [/favicon.ico]
- tools.staticfile.on = True
- tools.staticfile.filename = "/path/to/favicon.ico"
-
-If you want a favicon, but don't want CherryPy to serve it, you can point to an
-HTTP URL via a link element in the HTML head. See http://www.w3.org/2005/10/howto-favicon
-and http://en.wikipedia.org/wiki/Favicon for instructions.
diff --git a/sphinx/source/progguide/files/index.rst b/sphinx/source/progguide/files/index.rst
deleted file mode 100644
index d6e39ab0..00000000
--- a/sphinx/source/progguide/files/index.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-*************
-File Handling
-*************
-
-.. toctree::
- :maxdepth: 2
- :glob:
-
- *
-
-
diff --git a/sphinx/source/progguide/files/static.rst b/sphinx/source/progguide/files/static.rst
deleted file mode 100644
index f5c447a6..00000000
--- a/sphinx/source/progguide/files/static.rst
+++ /dev/null
@@ -1,298 +0,0 @@
-Serving Static Content
-**********************
-
-Static content is now handled by ``tools.staticfile`` and ``tools.staticdir`` that can easily be enabled and configured in your config file. For instance, if you wanted to serve ``/style.css`` from ``/home/site/style.css`` and ``/static/*`` from ``/home/site/static/*``, you can use the following configuration:
-
-::
-
- [/]
- tools.staticdir.root = "/home/site"
-
- [/style.css]
- tools.staticfile.on = True
- tools.staticfile.filename = "/home/site/style.css"
-
- [/static]
- tools.staticdir.on = True
- tools.staticdir.dir = "static"
-
-
-Parameters
-==========
-
- * on: True or False (default). Enable or disable the filter.
- * match: a :mod:`regular expression <re>` of files to match.
- * filename: path to the target file.
- * dir: path to the target directory.
- * root: absolute path to a "root"; joined with .dir or .filename if they are relative paths.
-
-Usage
-=====
-
-Serving files through the ``staticfile`` tool
----------------------------------------------
-
-Directory structure
-::
-
- cpapp \
- __init__.py
- data \
- scripts \
- dummy.js
- css \
- style.css
-
-
-Here is our `cpapp/__init__.py`:
-::
-
- #!python
- import os.path
- current_dir = os.path.dirname(os.path.abspath(__file__))
-
- import cherrypy
-
-
- class Root:
- @cherrypy.expose
- def index(self):
- return """<html>
- <head>
- <title>CherryPy static example</title>
- <link rel="stylesheet" type="text/css" href="css/style.css" type="text/css"></link>
- <script type="application/javascript" src="js/some.js"></script>
- </head>
- <body>
- <p>Static example</p>
- </body>
- </html>"""
-
-
-...and a `prod.conf` configuration file:
-
-::
-
- [global]
- environment: 'production'
- log.error_file: 'site.log'
- log.screen: True
-
- tree.cpapp: cherrypy.Application(cpapp.Root())
-
- [/css/style.css]
- tools.staticfile.on: True
- tools.staticfile.filename: cpapp.current_dir + '/data/css/style.css'
-
- [/js/some.js]
- tools.staticfile.on: True
- tools.staticfile.filename: cpapp.current_dir + '/data/scripts/dummy.js'
-
-
-Note how we use the absolute path to point at the static files. Note also that when using the ``staticfile`` tool, the logical URI path and the physical file do not need to be the same. Parts of their components can differ as in the case of the Javascript resource.
-
-You can run the above with:
-
-::
-
- $ cherryd -i cpapp -c prod.conf
-
-
-Serving files through the ``staticdir`` tool
---------------------------------------------
-
-Keeping the same directory structure as above, we could have written our config file as follows:
-
-::
-
- [/]
- tools.staticdir.root: cpapp.current_dir + 'data'
-
- [/css]
- tools.staticdir.on: True
- tools.staticdir.dir: 'css'
-
- [/js]
- tools.staticdir.on: True
- tools.staticdir.dir: 'scripts'
-
-
-However in this case the ``GET /js/some.js`` request will fail with a ``404 Not Found`` response because when using the ``staticdir`` tool the last segment of the URI must match exactly the path of the physical file underneath the directory defined by ``tools.staticdir.dir``.
-
-In our example we must either rename the physical file or change the HTML code accordingly.
-
-staticdir.index
-^^^^^^^^^^^^^^^
-
-If `tools.staticdir.index` is provided, it should be the (relative) name of a file to serve for directory requests. For example, if the `staticdir.dir` argument is '/home/me', the Request-URI is 'myapp', and the `.index` arg is 'index.html', the file '/home/me/myapp/index.html' will be served.
-
-Specify the content-type of static resource
--------------------------------------------
-
-Both the ``staticfile`` and ``staticdir`` tool allow you to specify the mime type of resources by their extension.
-Although internally CherryPy will most of the time guess the correct mime type (using the Python :mod:`mimetypes` module),
-there may be cases when you need to provide the content type values. You can do this via configuration arguments
-``tools.staticdir.content_types`` and ``tools.staticfile.content_types``, as in the following example.
-
-::
-
- #!python
- import os.path
- import cherrypy
-
- class Root:
- @cherrypy.expose
- def index(self):
- return """<html>
- <head>
- <title>CherryPy static tutorial</title>
- </head>
- <html>
- <body>
- <a href="feed/notes.rss">RSS 2.0</a>
- <br />
- <a href="feed/notes.atom">Atom 1.0</a>
- </body>
- </html>"""
-
- if __name__ == '__main__':
- current_dir = os.path.dirname(os.path.abspath(__file__))
- # Set up site-wide config first so we get a log if errors occur.
- cherrypy.config.update({'environment': 'production',
- 'log.error_file': 'site.log',
- 'log.screen': True})
-
- conf = {'/feed': {'tools.staticdir.on': True,
- 'tools.staticdir.dir': os.path.join(current_dir, 'feeds'),
- 'tools.staticdir.content_types': {'rss': 'application/xml',
- 'atom': 'application/atom+xml'}}}
- cherrypy.quickstart(Root(), '/', config=conf)
-
-
-The value of ``tools.staticdir.content_types`` and ``tools.staticfile.content_types``
-is a dictionary whose keys are filename extensions, and values are the corresponding
-media-type strings (for the ``Content-Type`` header). Note that the key must NOT include any leading '.'.
-
-Serve static content from a page handler bypassing the static tools
--------------------------------------------------------------------
-
-It may happen that you would need the static tools power but from a page handler itself so that you can add more processing. You can do so by calling the ``serve_file`` function.
-
-::
-
- #!python
- import os.path
- import cherrypy
- from cherrypy.lib.static import serve_file
-
- class Root:
- @cherrypy.expose
- def feed(self, name):
- accepts = cherrypy.request.headers.elements('Accept')
-
- for accept in accepts:
- if accept.value == 'application/atom+xml':
- return serve_file(os.path.join(current_dir, 'feeds', '%s.atom' % name),
- content_type='application/atom+xml')
-
- return serve_file(os.path.join(current_dir, 'feeds', '%s.rss' % name),
- content_type='application/xml')
-
- if __name__ == '__main__':
- current_dir = os.path.dirname(os.path.abspath(__file__))
- # Set up site-wide config first so we get a log if errors occur.
- cherrypy.config.update({'environment': 'production',
- 'log.error_file': 'site.log',
- 'log.screen': True})
- cherrypy.quickstart(Root(), '/')
-
-
-In this example we rely on the Accept header of the HTTP request to tell us which content type is supported by the client. If it can process the Atom content type then we serve the Atom resource, otherwise we serve the RSS one.
-
-In any case by using the serve_file function we benefit from the CherryPy internal processing of the request in regards of HTTP headers such as If-Modified-Since. In fact the static tools use the serve_file function.
-
-Troubleshooting staticdir
-=========================
-
-When using staticdir, "root" and "dir" are concatenated using ``os.path.join``. So if you're having problems, try ``os.path.join(root, dir)`` in an interactive interpreter and make sure you at least get a valid, absolute path. Remember, you don't have to use "root" at all if you don't want to; just make "dir" an absolute path. If root + dir is not absolute, an error will be raised asking you to make it absolute. CherryPy doesn't make any assumptions about where your project files are, nor can it trust the current working directory, since that may change or not be under your control depending on your deployment environment.
-
-Once root and dir are joined, the final file is found by ``os.path.join``'ing a ''branch''. The branch is pulled from the current request's URL like this:
-
-::
-
- http://www2.mydomain.org/vhost /path/to/my/approot /path/to/section / path/to/actual/file.jpg
- | | | | | | | |
- +----------- base -----------+ +-- script_name --+ +-- section ---+ +------ branch -------+
-
-
-The 'base' is the value of the 'Host' request header (unless changed by tools.proxy). The 'script_name' is where you mounted your app root. The 'section' is what part of the remaining URL to ''ignore''; that is, none of its path atoms need to map to filesystem folders. It should exactly match the section header in your application config file where you defined 'tools.staticdir.dir'. In this example, your application config file should have:
-
-::
-
- [/]
- tools.staticdir.root = '/home/me/testproj'
-
- [/path/to/section]
- tools.staticdir.dir = 'images/jpegs'
-
-
-Note that the section must start with a slash, but not end with one. And in order for ``os.path.join`` to work on root + dir, our 'images' value neither starts nor ends with a slash. Also note that the values of "root" and "dir" need not have ''anything'' to do with any part of the URL; they are OS path components only. Only the section header needs to match a portion of the URL.
-
-Now we're finally ready to slice off the part of the URL that is our ''branch'' and add it to root + dir. So our final example will try to open the following file:
-
-::
-
- root + dir + branch
- >>> os.path.join('/home/me/testproj', 'images/jpegs', 'path/to/actual/file.jpg')
- '/home/me/testproj/images/jpegs/path/to/actual/file.jpg'
-
-
-Forming URLs
-============
-
-Creating links to static content is the inverse of the above. If you want to serve the file:
-
-::
-
- /home/me/testproj/images/jpegs/path/to/actual/file.jpg
-
-
-...you have a choice about where to split up the full path into root, dir, and branch. Remember, the 'root' value only exists to save typing; you could use absolute paths for all "dir" values. So if you're serving multiple static directories, find the common root to them all and use that for your "root" value. For example, instead of this:
-
-::
-
- [/images]
- tools.staticdir.dir = "/usr/home/me/app/static/images"
-
- [/styles]
- tools.staticdir.dir = "/usr/home/me/app/static/css"
-
- [/scripts]
- tools.staticdir.dir = "/usr/home/me/app/static/js"
-
-
-...write:
-
-::
-
- [/]
- tools.staticdir.root = "/usr/home/me/app/static"
-
- [/images]
- tools.staticdir.dir = "images"
-
- [/styles]
- tools.staticdir.dir = "css"
-
- [/scripts]
- tools.staticdir.dir = "js"
-
-
-Regardless of where you split "root" from "dir", the remainder of the OS path will be the "branch". Assuming the config above, our example branch would then be "jpegs/path/to/actual/file.jpg". Add the branch to the section name where you defined "dir", and use that for your URL. Even better, pass it to ``cherrypy.url()`` (which prepends base and script_name) and emit ''that''.
-
-::
-
- section + branch
- >>> cherrypy.url('/images' + '/' + 'jpegs/path/to/actual/file.jpg')
- http://www2.mydomain.org/vhost/path/to/my/approot/images/jpegs/path/to/actual/file.jpg
-
diff --git a/sphinx/source/progguide/files/uploading.rst b/sphinx/source/progguide/files/uploading.rst
deleted file mode 100644
index 526bc511..00000000
--- a/sphinx/source/progguide/files/uploading.rst
+++ /dev/null
@@ -1,75 +0,0 @@
-***************
-Uploading Files
-***************
-
-When a client uploads a file to a CherryPy application, it's placed
-on disk immediately. CherryPy will pass it to your exposed method
-as an argument (see "myFile" below); that arg will have a "file"
-attribute, which is a handle to the temporary uploaded file.
-If you wish to permanently save the file, you need to read()
-from myFile.file and write() somewhere else.
-
-Note the use of 'enctype="multipart/form-data"' and 'input type="file"'
-in the HTML which the client uses to upload the file.
-
-
-Here is a simple example that shows how file uploads are handled by CherryPy::
-
- import os
- localDir = os.path.dirname(__file__)
- absDir = os.path.join(os.getcwd(), localDir)
-
- import cherrypy
-
- class FileDemo(object):
-
- def index(self):
- return """
- <html><body>
- <h2>Upload a file</h2>
- <form action="upload" method="post" enctype="multipart/form-data">
- filename: <input type="file" name="myFile" /><br />
- <input type="submit" />
- </form>
- <h2>Download a file</h2>
- <a href='download'>This one</a>
- </body></html>
- """
- index.exposed = True
-
- def upload(self, myFile):
- out = """<html>
- <body>
- myFile length: %s<br />
- myFile filename: %s<br />
- myFile mime-type: %s
- </body>
- </html>"""
-
- # Although this just counts the file length, it demonstrates
- # how to read large files in chunks instead of all at once.
- # CherryPy reads the uploaded file into a temporary file;
- # myFile.file.read reads from that.
- size = 0
- while True:
- data = myFile.file.read(8192)
- if not data:
- break
- size += len(data)
-
- return out % (size, myFile.filename, myFile.content_type)
- upload.exposed = True
-
-
-
- tutconf = os.path.join(os.path.dirname(__file__), 'tutorial.conf')
-
- if __name__ == '__main__':
- # CherryPy always starts with app.root when trying to map request URIs
- # to objects, so we need to mount a request handler root. A request
- # to '/' will be mapped to HelloWorld().index().
- cherrypy.quickstart(FileDemo(), config=tutconf)
- else:
- # This branch is for the test suite; you can ignore it.
- cherrypy.tree.mount(FileDemo(), config=tutconf)
-
diff --git a/sphinx/source/progguide/index.rst b/sphinx/source/progguide/index.rst
deleted file mode 100644
index 9b54428b..00000000
--- a/sphinx/source/progguide/index.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-******************
-Programmer's Guide
-******************
-
-When you build a web application, you need more than just headers and bodies.
-Here are a number of discussions on how to add higher-level features to your
-CherryPy application, and how to leverage some of the power of HTTP.
-
-Features
-========
-
-.. toctree::
- :maxdepth: 2
-
- choosingtemplate
- Exceptions </refman/_cperror>
- files/index
- Logging </refman/_cplogging>
- responsetimeouts
- Sessions </refman/lib/sessions>
- security
- extending/index
-
-
-HTTP details
-============
-
-.. toctree::
- :maxdepth: 2
-
- cookies
- customheaders
- Request Bodies </refman/_cpreqbody>
- REST
- streaming
-
diff --git a/sphinx/source/progguide/responsetimeouts.rst b/sphinx/source/progguide/responsetimeouts.rst
deleted file mode 100644
index a024eb1b..00000000
--- a/sphinx/source/progguide/responsetimeouts.rst
+++ /dev/null
@@ -1,41 +0,0 @@
-*****************
-Response Timeouts
-*****************
-
-CherryPy responses include 3 attributes related to time:
-
- * ``response.time``: the :func:`time.time` at which the response began
- * ``response.timeout``: the number of seconds to allow responses to run
- * ``response.timed_out``: a boolean indicating whether the response has
- timed out (default False).
-
-The request processing logic inspects the value of ``response.timed_out`` at
-various stages; if it is ever True, then :class:`TimeoutError` is raised.
-You are free to do the same within your own code.
-
-Rather than calculate the difference by hand, you can call
-``response.check_timeout`` to set ``timed_out`` for you.
-
-
-.. _timeoutmonitor:
-
-Timeout Monitor
-===============
-
-In addition, CherryPy includes a ``cherrypy.engine.timeout_monitor`` which
-monitors all active requests in a separate thread; periodically, it calls
-``check_timeout`` on them all. It is subscribed by default. To turn it off::
-
- [global]
- engine.timeout_monitor.on: False
-
-or::
-
- cherrypy.engine.timeout_monitor.unsubscribe()
-
-You can also change the interval (in seconds) at which the timeout monitor runs::
-
- [global]
- engine.timeout_monitor.frequency: 60 * 60
-
-The default is once per minute. The above example changes that to once per hour.
diff --git a/sphinx/source/progguide/security.rst b/sphinx/source/progguide/security.rst
deleted file mode 100644
index 3375c8cc..00000000
--- a/sphinx/source/progguide/security.rst
+++ /dev/null
@@ -1,109 +0,0 @@
-********************************
-Securing CherryPy
-********************************
-
-There are several settings that can be enabled to make CherryPy pages more secure. These include:
-
- Transmitting data:
-
- #. Use Secure Cookies
-
- Rendering pages:
-
- #. Set HttpOnly cookies
- #. Set XFrame options
- #. Enable XSS Protection
- #. Set the Content Security Policy
-
-An easy way to accomplish this is to set headers with a :doc:`Tool </tutorial/tools>` and wrap your entire CherryPy application with it::
-
- import cherrypy
-
- def secureheaders():
- headers = cherrypy.response.headers
- headers['X-Frame-Options'] = 'DENY'
- headers['X-XSS-Protection'] = '1; mode=block'
- headers['Content-Security-Policy'] = "default-src='self'"
-
- # set the priority according to your needs if you are hooking something
- # else on the 'before_finalize' hook point.
- cherrypy.tools.secureheaders = \
- cherrypy.Tool('before_finalize', secureheaders, priority=60)
-
-
-Then, in the :doc:`configuration file </tutorial/config>` (or any other place that you want to enable the tool)::
-
- [/]
- tools.secureheaders.on = True
-
-
-If you use :doc:`sessions </refman/lib/sessions>` you can also enable these settings::
-
- [/]
- tools.sessions.on = True
- # increase security on sessions
- tools.sessions.secure = True
- tools.sessions.httponly = True
-
-
-If you use SSL you can also enable Strict Transport Security::
-
- # add this to secureheaders():
- # only add Strict-Transport headers if we're actually using SSL; see the ietf spec
- # "An HSTS Host MUST NOT include the STS header field in HTTP responses
- # conveyed over non-secure transport"
- # http://tools.ietf.org/html/draft-ietf-websec-strict-transport-sec-14#section-7.2
- if (cherrypy.server.ssl_certificate != None and cherrypy.server.ssl_private_key != None):
- headers['Strict-Transport-Security'] = 'max-age=31536000' # one year
-
-
-Using Secure Socket Layers (SSL)
-================================
-
-CherryPy can encrypt connections using SSL to create an https connection. This keeps your web traffic secure. Here's how.
-
-1. Generate a private key. We'll use openssl and follow the `OpenSSL Keys HOWTO <https://www.openssl.org/docs/HOWTO/keys.txt>`_.::
-
- $ openssl genrsa -out privkey.pem 2048
-
-You can create either a key that requires a password to use, or one without a password. Protecting your private key with a password is much more secure, but requires that you enter the password every time you use the key. For example, you may have to enter the password when you start or restart your CherryPy server. This may or may not be feasible, depending on your setup.
-
-If you want to require a password, add one of the ``-aes128``, ``-aes192`` or ``-aes256`` switches to the command above. You should not use any of the DES, 3DES, or SEED algoritms to protect your password, as they are insecure.
-
-SSL Labs recommends using 2048-bit RSA keys for security (see references section at the end).
-
-
-2. Generate a certificate. We'll use openssl and follow the `OpenSSL Certificates HOWTO <https://www.openssl.org/docs/HOWTO/certificates.txt>`_. Let's start off with a self-signed certificate for testing::
-
- $ openssl req -new -x509 -days 365 -key privkey.pem -out cert.pem
-
-openssl will then ask you a series of questions. You can enter whatever values are applicable, or leave most fields blank. The one field you *must* fill in is the 'Common Name': enter the hostname you will use to access your site. If you are just creating a certificate to test on your own machine and you access the server by typing 'localhost' into your browser, enter the Common Name 'localhost'.
-
-
-3. Decide whether you want to use python's built-in SSL library, or the pyOpenSSL library. CherryPy supports either.
-
- a) *Built-in.* To use python's built-in SSL, add the following line to your CherryPy config::
-
- cherrypy.server.ssl_module = 'builtin'
-
- b) *pyOpenSSL*. Because python did not have a built-in SSL library when CherryPy was first created, the default setting is to use pyOpenSSL. To use it you'll need to install it::
-
- $ pip install pyOpenSSL
-
-
-4. Add the following lines in your CherryPy config to point to your certificate files::
-
- cherrypy.server.ssl_certificate = "cert.pem"
- cherrypy.server.ssl_private_key = "privkey.pem"
-
-
-5. Start your CherryPy server normally. Note that if you are debugging locally and/or using a self-signed certificate, your browser may show you security warnings.
-
-
-
-Further Security Resources
-==========================
-
-* For an introduction to webserver security see `Dan Callahan's presentation from PyCon CA 2013 <http://pyvideo.org/video/2315/quick-wins-for-better-website-security>`_.
-* SSL Labs: `SSL/TLS Deployment Best Practises <https://www.ssllabs.com/projects/best-practices/>`_
-
diff --git a/sphinx/source/progguide/streaming.rst b/sphinx/source/progguide/streaming.rst
deleted file mode 100644
index 58b00fe7..00000000
--- a/sphinx/source/progguide/streaming.rst
+++ /dev/null
@@ -1,83 +0,0 @@
-***************************
-Streaming the response body
-***************************
-
-CherryPy handles HTTP requests, packing and unpacking the low-level details,
-then passing control to your application's :ref:`pagehandlers`, which produce
-the body of the response. CherryPy allows you to return body content in a
-variety of types: a string, a list of strings, a file. CherryPy also allows you
-to *yield* content, rather than *return* content. When you use "yield", you also
-have the option of streaming the output.
-
-**In general, it is safer and easier to not stream output.** Therefore,
-streaming output is off by default. Streaming output and also using sessions
-requires a good understanding of :py:mod:`how session locks work
-<cherrypy.lib.sessions>`.
-
-The "normal" CherryPy response process
-======================================
-
-When you provide content from your page handler, CherryPy manages the
-conversation between the HTTP server and your code like this:
-
-.. image:: cpreturn.gif
-
-Notice that the HTTP server gathers all output first and then writes everything
-to the client at once: status, headers, and body. This works well for static or
-simple pages, since the entire response can be changed at any time, either in
-your application code, or by the CherryPy framework.
-
-How "streaming output" works with CherryPy
-==========================================
-
-When you set the config entry "response.stream" to True (and use "yield"),
-CherryPy manages the conversation between the HTTP server and your code like this:
-
-.. image:: cpyield.gif
-
-When you stream, your application doesn't immediately pass raw body content
-back to CherryPy or to the HTTP server. Instead, it passes back a generator.
-At that point, CherryPy finalizes the status and headers, **before** the
-generator has been consumed, or has produced any output. This is necessary to
-allow the HTTP server to send the headers and pieces of the body as they become
-available.
-
-Once CherryPy has set the status and headers, it sends them to the HTTP server,
-which then writes them out to the client. From that point on, the CherryPy
-ramework mostly steps out of the way, and the HTTP server essentially requests
-content directly from your application code (your page handler method).
-
-Therefore, when streaming, if an error occurs within your page handler,
-CherryPy will not catch it--the HTTP server will catch it. Because the headers
-(and potentially some of the body) have already been written to the client,
-the server *cannot* know a safe means of handling the error, and will therefore
-simply close the connection (the current, builtin servers actually write out a
-short error message in the body, but this may be changed, and is not guaranteed
-behavior for all HTTP servers you might use with CherryPy).
-
-In addition, you cannot manually modify the status or headers within your page
-handler if that handler method is a streaming generator, because the method will
-not be iterated over until after the headers have been written to the client.
-**This includes raising exceptions like HTTPError, NotFound, InternalRedirect
-and HTTPRedirect.** To use a streaming generator while modifying headers, you
-would have to return a generator that is separate from (or embedded in) your
-page handler. For example::
-
- class Root:
- def thing(self):
- cherrypy.response.headers['Content-Type'] = 'text/plain'
- if not authorized():
- raise cherrypy.NotFound()
- def content():
- yield "Hello, "
- yield "world"
- return content()
- thing._cp_config = {'response.stream': True}
-
-Streaming generators are sexy, but they play havoc with HTTP. CherryPy allows
-you to stream output for specific situations: pages which take many minutes to
-produce, or pages which need a portion of their content immediately output to
-the client. Because of the issues outlined above, **it is usually better to
-flatten (buffer) content rather than stream content**. Do otherwise only when
-the benefits of streaming outweigh the risks.
-
diff --git a/sphinx/source/refman/_cpchecker.rst b/sphinx/source/refman/_cpchecker.rst
deleted file mode 100644
index 68b87ee1..00000000
--- a/sphinx/source/refman/_cpchecker.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-**************************
-:mod:`cherrypy._cpchecker`
-**************************
-
-.. automodule:: cherrypy._cpchecker
-
-Classes
-=======
-
-.. autoclass:: Checker
- :members:
-
diff --git a/sphinx/source/refman/_cpconfig.rst b/sphinx/source/refman/_cpconfig.rst
deleted file mode 100644
index b6c5ac4e..00000000
--- a/sphinx/source/refman/_cpconfig.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-*************************
-:mod:`cherrypy._cpconfig`
-*************************
-
-.. automodule:: cherrypy._cpconfig
-
-Classes
-=======
-
-.. autoclass:: Config
- :members:
- :inherited-members:
-
-Functions
-=========
-
-.. autofunction:: merge
-
diff --git a/sphinx/source/refman/_cpdispatch.rst b/sphinx/source/refman/_cpdispatch.rst
deleted file mode 100644
index 28c333a4..00000000
--- a/sphinx/source/refman/_cpdispatch.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-********************************************************
-:mod:`cherrypy._cpdispatch` -- Mapping URI's to handlers
-********************************************************
-
-.. automodule:: cherrypy._cpdispatch
-
-Classes
-=======
-
-.. autoclass:: PageHandler
- :members:
-
-.. autoclass:: LateParamPageHandler
- :members:
-
-.. autoclass:: Dispatcher
- :members:
-
-.. autoclass:: MethodDispatcher
- :members:
-
-.. autoclass:: RoutesDispatcher
- :members:
-
-.. autoclass:: XMLRPCDispatcher
- :members:
-
-.. autoclass:: VirtualHost
- :members:
-
-
diff --git a/sphinx/source/refman/_cperror.rst b/sphinx/source/refman/_cperror.rst
deleted file mode 100644
index 1e6042c2..00000000
--- a/sphinx/source/refman/_cperror.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-*************************
-:mod:`cherrypy._cperror`
-*************************
-
-.. automodule:: cherrypy._cperror
-
-Classes
-=======
-
-.. autoclass:: CherryPyException
- :members:
-
-.. autoclass:: TimeoutError
- :members:
-
-.. autoclass:: InternalRedirect
- :members:
-
-.. autoclass:: HTTPRedirect
- :members:
-
-.. autoclass:: HTTPError
- :members:
-
-.. autoclass:: NotFound
- :members:
-
-Functions
-=========
-
-.. autofunction:: format_exc
-
diff --git a/sphinx/source/refman/_cplogging.rst b/sphinx/source/refman/_cplogging.rst
deleted file mode 100644
index 3594c29e..00000000
--- a/sphinx/source/refman/_cplogging.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-**************************
-:mod:`cherrypy._cplogging`
-**************************
-
-.. automodule:: cherrypy._cplogging
-
-Classes
-=======
-
-.. autoclass:: LogManager
- :members:
-
-.. autoclass:: WSGIErrorHandler
- :members:
-
diff --git a/sphinx/source/refman/_cpreqbody.rst b/sphinx/source/refman/_cpreqbody.rst
deleted file mode 100644
index 58dca8f5..00000000
--- a/sphinx/source/refman/_cpreqbody.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-**************************
-:mod:`cherrypy._cpreqbody`
-**************************
-
-.. automodule:: cherrypy._cpreqbody
-
-Classes
-=======
-
-.. autoclass:: Entity
- :members:
-
-.. autoclass:: Part
- :show-inheritance:
- :members:
- :inherited-members:
-
-.. autoclass:: RequestBody
- :show-inheritance:
- :members:
- :inherited-members:
-
-.. autoclass:: SizedReader
- :members:
-
-
-Functions
-=========
-
-.. autofunction:: process_urlencoded
-
-.. autofunction:: process_multipart
-
-.. autofunction:: process_multipart_form_data
-
diff --git a/sphinx/source/refman/_cprequest.rst b/sphinx/source/refman/_cprequest.rst
deleted file mode 100644
index 475666ae..00000000
--- a/sphinx/source/refman/_cprequest.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-**************************
-:mod:`cherrypy._cprequest`
-**************************
-
-.. automodule:: cherrypy._cprequest
-
-Classes
-=======
-
-.. autoclass:: Request
- :members:
-
-.. autoclass:: Response
- :members:
-
-.. autoclass:: Hook
- :members:
-
-.. autoclass:: HookMap
- :members:
-
-
diff --git a/sphinx/source/refman/_cpserver.rst b/sphinx/source/refman/_cpserver.rst
deleted file mode 100644
index 8f2ea543..00000000
--- a/sphinx/source/refman/_cpserver.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-*************************
-:mod:`cherrypy._cpserver`
-*************************
-
-.. automodule:: cherrypy._cpserver
-
-Classes
-=======
-
-.. autoclass:: Server
- :members:
-
diff --git a/sphinx/source/refman/_cptools.rst b/sphinx/source/refman/_cptools.rst
deleted file mode 100644
index e3ddc48c..00000000
--- a/sphinx/source/refman/_cptools.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-************************
-:mod:`cherrypy._cptools`
-************************
-
-See :doc:`/tutorial/tools` for a conceptual overview of CherryPy Tools.
-
-.. automodule:: cherrypy._cptools
-
-Classes
-=======
-
-.. autoclass:: Tool
- :members:
-
-.. autoclass:: HandlerTool
- :members:
-
-.. autoclass:: HandlerWrapperTool
- :members:
-
-.. autoclass:: ErrorTool
- :members:
-
-.. autoclass:: SessionTool
- :members:
-
-.. autoclass:: XMLRPCController
- :members:
-
-.. autoclass:: SessionAuthTool
- :members:
-
-.. autoclass:: CachingTool
- :members:
-
-.. autoclass:: Toolbox
- :members:
-
-
diff --git a/sphinx/source/refman/_cptree.rst b/sphinx/source/refman/_cptree.rst
deleted file mode 100644
index 7df25387..00000000
--- a/sphinx/source/refman/_cptree.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-***********************
-:mod:`cherrypy._cptree`
-***********************
-
-.. automodule:: cherrypy._cptree
-
-Classes
-=======
-
-.. autoclass:: Application
- :members:
-
-.. autoclass:: Tree
- :members:
-
diff --git a/sphinx/source/refman/_cpwsgi.rst b/sphinx/source/refman/_cpwsgi.rst
deleted file mode 100644
index 44c52cc5..00000000
--- a/sphinx/source/refman/_cpwsgi.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-***********************
-:mod:`cherrypy._cpwsgi`
-***********************
-
-.. automodule:: cherrypy._cpwsgi
-
-Classes
-=======
-
-.. autoclass:: VirtualHost
- :members:
-
-.. autoclass:: InternalRedirector
- :members:
-
-.. autoclass:: ExceptionTrapper
- :members:
-
-.. autoclass:: AppResponse
- :members:
-
-.. autoclass:: CPWSGIApp
- :members:
-
diff --git a/sphinx/source/refman/cherrypy.rst b/sphinx/source/refman/cherrypy.rst
deleted file mode 100644
index a6ea0bb5..00000000
--- a/sphinx/source/refman/cherrypy.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-***************
-:mod:`cherrypy`
-***************
-
-.. automodule:: cherrypy
-
-
-Classes
-=======
-
-.. autoclass:: HTTPError
- :members:
-
-.. autoclass:: HTTPRedirect
- :members:
-
-.. autoclass:: InternalRedirect
- :members:
-
-.. autoclass:: NotFound
- :members:
-
-.. autoclass:: CherryPyException
- :members:
-
-.. autoclass:: TimeoutError
- :members:
-
-
-Functions
-=========
-
-.. autofunction:: expose
-
-.. autofunction:: log
-
-.. autofunction:: quickstart
-
-.. autofunction:: url
-
diff --git a/sphinx/source/refman/cperrors.gif b/sphinx/source/refman/cperrors.gif
deleted file mode 100644
index 4414539a..00000000
--- a/sphinx/source/refman/cperrors.gif
+++ /dev/null
Binary files differ
diff --git a/sphinx/source/refman/index.rst b/sphinx/source/refman/index.rst
deleted file mode 100644
index 993b9328..00000000
--- a/sphinx/source/refman/index.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-****************
-Reference Manual
-****************
-
-.. toctree::
- :glob:
-
- *
- lib/index
- process/index
- wsgiserver/index
-
diff --git a/sphinx/source/refman/lib/auth.rst b/sphinx/source/refman/lib/auth.rst
deleted file mode 100644
index 7008e268..00000000
--- a/sphinx/source/refman/lib/auth.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-************************
-:mod:`cherrypy.lib.auth`
-************************
-
-.. automodule:: cherrypy.lib.auth
-
-Functions
-=========
-
-.. autofunction:: check_auth
-
-.. autofunction:: basic_auth
-
-.. autofunction:: digest_auth
diff --git a/sphinx/source/refman/lib/auth_basic.rst b/sphinx/source/refman/lib/auth_basic.rst
deleted file mode 100644
index ce637fc5..00000000
--- a/sphinx/source/refman/lib/auth_basic.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-******************************
-:mod:`cherrypy.lib.auth_basic`
-******************************
-
-.. automodule:: cherrypy.lib.auth_basic
-
-Functions
-=========
-
-.. autofunction:: checkpassword_dict
-
-.. autofunction:: basic_auth
diff --git a/sphinx/source/refman/lib/auth_digest.rst b/sphinx/source/refman/lib/auth_digest.rst
deleted file mode 100644
index f45d0755..00000000
--- a/sphinx/source/refman/lib/auth_digest.rst
+++ /dev/null
@@ -1,26 +0,0 @@
-*******************************
-:mod:`cherrypy.lib.auth_digest`
-*******************************
-
-.. automodule:: cherrypy.lib.auth_digest
-
-Classes
-=======
-
-.. autoclass:: HttpDigestAuthorization
- :members:
-
-Functions
-=========
-
-.. autofunction:: get_ha1_dict_plain
-
-.. autofunction:: get_ha1_dict
-
-.. autofunction:: get_ha1_file_htdigest
-
-.. autofunction:: synthesize_nonce
-
-.. autofunction:: www_authenticate
-
-.. autofunction:: digest_auth
diff --git a/sphinx/source/refman/lib/caching.rst b/sphinx/source/refman/lib/caching.rst
deleted file mode 100644
index d109a9b5..00000000
--- a/sphinx/source/refman/lib/caching.rst
+++ /dev/null
@@ -1,26 +0,0 @@
-***************************
-:mod:`cherrypy.lib.caching`
-***************************
-
-.. automodule:: cherrypy.lib.caching
-
-Classes
-=======
-
-.. autoclass:: Cache
- :members:
-
-.. autoclass:: AntiStampedeCache
- :members:
-
-.. autoclass:: MemoryCache
- :members:
-
-Functions
-=========
-
-.. autofunction:: get
-
-.. autofunction:: tee_output
-
-.. autofunction:: expires
diff --git a/sphinx/source/refman/lib/covercp.rst b/sphinx/source/refman/lib/covercp.rst
deleted file mode 100644
index b6cf9101..00000000
--- a/sphinx/source/refman/lib/covercp.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-***************************
-:mod:`cherrypy.lib.covercp`
-***************************
-
-.. automodule:: cherrypy.lib.covercp
-
-Classes
-=======
-
-.. autoclass:: CoverStats
- :members:
-
-Functions
-=========
-
-.. autofunction:: get_tree
-
-.. autofunction:: serve
diff --git a/sphinx/source/refman/lib/cpstats.rst b/sphinx/source/refman/lib/cpstats.rst
deleted file mode 100644
index 697bd7d2..00000000
--- a/sphinx/source/refman/lib/cpstats.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-*****************************
-:mod:`cherrypy.lib.cpstats`
-*****************************
-
-.. automodule:: cherrypy.lib.cpstats
-
-Classes
-=======
-
-.. autoclass:: StatsTool
- :members:
-.. autoclass:: StatsPage
-
diff --git a/sphinx/source/refman/lib/cptools.rst b/sphinx/source/refman/lib/cptools.rst
deleted file mode 100644
index b139fb0f..00000000
--- a/sphinx/source/refman/lib/cptools.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-***************************
-:mod:`cherrypy.lib.cptools`
-***************************
-
-.. automodule:: cherrypy.lib.cptools
-
-Classes
-=======
-
-.. autoclass:: SessionAuth
- :members:
-
-.. autoclass:: MonitoredHeaderMap
- :members:
-
-Functions
-=========
-
-.. autofunction:: validate_etags
-
-.. autofunction:: validate_since
-
-.. autofunction:: proxy
-
-.. autofunction:: ignore_headers
-
-.. autofunction:: response_headers
-
-.. autofunction:: referer
-
-.. autofunction:: session_auth
-
-.. autofunction:: log_traceback
-
-.. autofunction:: log_request_headers
-
-.. autofunction:: log_hooks
-
-.. autofunction:: redirect
-
-.. autofunction:: trailing_slash
-
-.. autofunction:: flatten
-
-.. autofunction:: accept
-
-.. autofunction:: allow
-
-.. autofunction:: autovary
diff --git a/sphinx/source/refman/lib/encoding.rst b/sphinx/source/refman/lib/encoding.rst
deleted file mode 100644
index 0171e565..00000000
--- a/sphinx/source/refman/lib/encoding.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-****************************
-:mod:`cherrypy.lib.encoding`
-****************************
-
-.. automodule:: cherrypy.lib.encoding
-
-Classes
-=======
-
-.. autoclass:: ResponseEncoder
- :members:
-
-Functions
-=========
-
-.. autofunction:: decode
-
-.. autofunction:: compress
-
-.. autofunction:: decompress
-
-.. autofunction:: gzip
diff --git a/sphinx/source/refman/lib/httpauth.rst b/sphinx/source/refman/lib/httpauth.rst
deleted file mode 100644
index c0e871c2..00000000
--- a/sphinx/source/refman/lib/httpauth.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-****************************
-:mod:`cherrypy.lib.httpauth`
-****************************
-
-.. automodule:: cherrypy.lib.httpauth
-
-Functions
-=========
-
-.. autofunction:: calculateNonce
-
-.. autofunction:: digestAuth
-
-.. autofunction:: basicAuth
-
-.. autofunction:: doAuth
-
-.. autofunction:: parseAuthorization
-
-.. autofunction:: md5SessionKey
-
-.. autofunction:: checkResponse
-
diff --git a/sphinx/source/refman/lib/httputil.rst b/sphinx/source/refman/lib/httputil.rst
deleted file mode 100644
index 646e55a8..00000000
--- a/sphinx/source/refman/lib/httputil.rst
+++ /dev/null
@@ -1,41 +0,0 @@
-****************************
-:mod:`cherrypy.lib.httputil`
-****************************
-
-.. automodule:: cherrypy.lib.httputil
-
-Classes
-=======
-
-.. autoclass:: HeaderElement
- :members:
-
-.. autoclass:: AcceptElement
- :members:
-
-.. autoclass:: CaseInsensitiveDict
- :members:
-
-.. autoclass:: HeaderMap
- :members:
-
-.. autoclass:: Host
- :members:
-
-Functions
-=========
-
-.. autofunction:: urljoin
-
-.. autofunction:: protocol_from_http
-
-.. autofunction:: get_ranges
-
-.. autofunction:: header_elements
-
-.. autofunction:: decode_TEXT
-
-.. autofunction:: valid_status
-
-.. autofunction:: parse_query_string
-
diff --git a/sphinx/source/refman/lib/index.rst b/sphinx/source/refman/lib/index.rst
deleted file mode 100644
index 72c875a5..00000000
--- a/sphinx/source/refman/lib/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-************
-cherrypy.lib
-************
-
-.. toctree::
- :glob:
-
- *
-
-
diff --git a/sphinx/source/refman/lib/jsontools.rst b/sphinx/source/refman/lib/jsontools.rst
deleted file mode 100644
index 8ec01453..00000000
--- a/sphinx/source/refman/lib/jsontools.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-*****************************
-:mod:`cherrypy.lib.jsontools`
-*****************************
-
-.. automodule:: cherrypy.lib.jsontools
-
-Functions
-=========
-
-.. autofunction:: json_processor
-
-.. autofunction:: json_in
-
-.. autofunction:: json_handler
-
-.. autofunction:: json_out
diff --git a/sphinx/source/refman/lib/profiler.rst b/sphinx/source/refman/lib/profiler.rst
deleted file mode 100644
index a7480693..00000000
--- a/sphinx/source/refman/lib/profiler.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-****************************
-:mod:`cherrypy.lib.profiler`
-****************************
-
-.. automodule:: cherrypy.lib.profiler
-
-Classes
-=======
-
-.. autoclass:: Profiler
- :members:
-
-.. autoclass:: ProfileAggregator
- :members:
-
-.. autoclass:: make_app
- :members:
-
-Functions
-=========
-
-.. autofunction:: new_func_strip_path
-
-.. autofunction:: serve
diff --git a/sphinx/source/refman/lib/reprconf.rst b/sphinx/source/refman/lib/reprconf.rst
deleted file mode 100644
index 62dc013e..00000000
--- a/sphinx/source/refman/lib/reprconf.rst
+++ /dev/null
@@ -1,29 +0,0 @@
-****************************
-:mod:`cherrypy.lib.reprconf`
-****************************
-
-.. automodule:: cherrypy.lib.reprconf
-
-Classes
-=======
-
-.. autoclass:: NamespaceSet
- :members:
-
-.. autoclass:: Config
- :members:
-
-.. autoclass:: Parser
- :members:
-
-Functions
-=========
-
-.. autofunction:: as_dict
-
-.. autofunction:: unrepr
-
-.. autofunction:: modules
-
-.. autofunction:: attributes
-
diff --git a/sphinx/source/refman/lib/sessions.rst b/sphinx/source/refman/lib/sessions.rst
deleted file mode 100644
index 822f7797..00000000
--- a/sphinx/source/refman/lib/sessions.rst
+++ /dev/null
@@ -1,41 +0,0 @@
-****************************
-:mod:`cherrypy.lib.sessions`
-****************************
-
-.. automodule:: cherrypy.lib.sessions
-
-Classes
-=======
-
-.. autoclass:: Session
- :members:
-
-.. autoclass:: RamSession
- :members:
- :inherited-members:
-
-.. autoclass:: FileSession
- :members:
- :inherited-members:
-
-.. autoclass:: PostgresqlSession
- :members:
- :inherited-members:
-
-.. autoclass:: MemcachedSession
- :members:
- :inherited-members:
-
-Functions
-=========
-
-.. autofunction:: save
-
-.. autofunction:: close
-
-.. autofunction:: init
-
-.. autofunction:: set_response_cookie
-
-.. autofunction:: expire
-
diff --git a/sphinx/source/refman/lib/static.rst b/sphinx/source/refman/lib/static.rst
deleted file mode 100644
index 41b10291..00000000
--- a/sphinx/source/refman/lib/static.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-**************************
-:mod:`cherrypy.lib.static`
-**************************
-
-.. automodule:: cherrypy.lib.static
-
-Functions
-=========
-
-.. autofunction:: serve_file
-
-.. autofunction:: serve_fileobj
-
-.. autofunction:: serve_download
-
-.. autofunction:: staticdir
-
-.. autofunction:: staticfile
-
diff --git a/sphinx/source/refman/lib/xmlrpc.rst b/sphinx/source/refman/lib/xmlrpc.rst
deleted file mode 100644
index e6b75de7..00000000
--- a/sphinx/source/refman/lib/xmlrpc.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-******************************
-:mod:`cherrypy.lib.xmlrpcutil`
-******************************
-
-.. automodule:: cherrypy.lib.xmlrpcutil
-
-Functions
-=========
-
-.. autofunction:: process_body
-
-.. autofunction:: patched_path
-
-.. autofunction:: respond
-
-.. autofunction:: on_error
-
diff --git a/sphinx/source/refman/process/index.rst b/sphinx/source/refman/process/index.rst
deleted file mode 100644
index c0a93a78..00000000
--- a/sphinx/source/refman/process/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-****************
-cherrypy.process
-****************
-
-.. toctree::
- :glob:
-
- *
- plugins/index
-
diff --git a/sphinx/source/refman/process/plugins/daemonizer.rst b/sphinx/source/refman/process/plugins/daemonizer.rst
deleted file mode 100644
index a5296ce4..00000000
--- a/sphinx/source/refman/process/plugins/daemonizer.rst
+++ /dev/null
@@ -1,47 +0,0 @@
-***************
-Run as a daemon
-***************
-
-CherryPy allows you to easily decouple the current process from the parent
-environment, using the traditional double-fork::
-
- from cherrypy.process.plugins import Daemonizer
- d = Daemonizer(cherrypy.engine)
- d.subscribe()
-
-.. note::
-
- This :ref:`Engine Plugin<plugins>` is only available on
- Unix and similar systems which provide fork().
-
-If a startup error occurs in the forked children, the return code from the
-parent process will still be 0. Errors in the initial daemonizing process still
-return proper exit codes, but errors after the fork won't. Therefore, if you use
-this plugin to daemonize, don't use the return code as an accurate indicator of
-whether the process fully started. In fact, that return code only indicates if
-the process successfully finished the first fork.
-
-The plugin takes optional arguments to redirect standard streams: ``stdin``,
-``stdout``, and ``stderr``. By default, these are all redirected to
-:file:`/dev/null`, but you're free to send them to log files or elsewhere.
-
-.. warning::
-
- You should be careful to not start any threads before this plugin runs.
- The plugin will warn if you do so, because "...the effects of calling functions
- that require certain resources between the call to fork() and the call to an
- exec function are undefined". (`ref <http://www.opengroup.org/onlinepubs/000095399/functions/fork.html>`_).
- It is for this reason that the Server plugin runs at priority 75 (it starts
- worker threads), which is later than the default priority of 65 for the
- Daemonizer.
-
-
-.. currentmodule:: cherrypy.process.plugins
-
-Classes
-=======
-
-.. autoclass:: Daemonizer
- :members:
- :show-inheritance:
-
diff --git a/sphinx/source/refman/process/plugins/dropprivileges.rst b/sphinx/source/refman/process/plugins/dropprivileges.rst
deleted file mode 100644
index 5eab3337..00000000
--- a/sphinx/source/refman/process/plugins/dropprivileges.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-***************
-Drop privileges
-***************
-
-Use this :ref:`Engine Plugin<plugins>` to start your
-CherryPy site as root (for example, to listen on a privileged port like 80)
-and then reduce privileges to something more restricted.
-
-This priority of this plugin's "start" listener is slightly higher than the
-priority for ``server.start`` in order to facilitate the most common use:
-starting on a low port (which requires root) and then dropping to another user.
-
-Example::
-
- DropPrivileges(cherrypy.engine, uid=1000, gid=1000).subscribe()
-
-.. currentmodule:: cherrypy.process.plugins
-
-Classes
-=======
-
-.. autoclass:: DropPrivileges
- :members:
- :show-inheritance:
-
diff --git a/sphinx/source/refman/process/plugins/index.rst b/sphinx/source/refman/process/plugins/index.rst
deleted file mode 100644
index a2ebb161..00000000
--- a/sphinx/source/refman/process/plugins/index.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-*************************************************
-:mod:`cherrypy.process.plugins` -- Engine Plugins
-*************************************************
-
-.. automodule:: cherrypy.process.plugins
-
-Classes
-=======
-
-.. autoclass:: SimplePlugin
- :members:
-
-.. autoclass:: ThreadManager
- :members:
- :show-inheritance:
-
-Monitors
---------
-
-.. autoclass:: BackgroundTask
- :members:
-
-.. autoclass:: PerpetualTimer
- :members:
-
-.. autoclass:: Monitor
- :members:
- :show-inheritance:
-
-.. autoclass:: Autoreloader
- :members:
- :inherited-members:
- :show-inheritance:
-
-
-Other Plugins
--------------
-
-.. toctree::
- :maxdepth: 2
-
- signalhandler
- dropprivileges
- daemonizer
- pidfile
-
diff --git a/sphinx/source/refman/process/plugins/pidfile.rst b/sphinx/source/refman/process/plugins/pidfile.rst
deleted file mode 100644
index 3c02a0ce..00000000
--- a/sphinx/source/refman/process/plugins/pidfile.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-*********
-PID files
-*********
-
-The PIDFile :ref:`Engine Plugin<plugins>` is pretty straightforward: it writes
-the process id to a file on start, and deletes the file on exit. You must
-provide a 'pidfile' argument, preferably an absolute path::
-
- PIDFile(cherrypy.engine, '/var/run/myapp.pid').subscribe()
-
-.. currentmodule:: cherrypy.process.plugins
-
-Classes
-=======
-
-.. autoclass:: PIDFile
- :members:
- :show-inheritance:
-
-
diff --git a/sphinx/source/refman/process/plugins/signalhandler.rst b/sphinx/source/refman/process/plugins/signalhandler.rst
deleted file mode 100644
index 5e8ced32..00000000
--- a/sphinx/source/refman/process/plugins/signalhandler.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-****************
-Handling Signals
-****************
-
-SignalHandler
-=============
-
-This :ref:`Engine Plugin<plugins>` is instantiated automatically as
-``cherrypy.engine.signal_handler``.
-However, it is only *subscribed* automatically by ``cherrypy.quickstart()``.
-So if you want signal handling and you're calling::
-
- tree.mount(); engine.start(); engine.block()
-
-on your own, be sure to add::
-
- if hasattr(cherrypy.engine, 'signal_handler'):
- cherrypy.engine.signal_handler.subscribe()
-
-.. currentmodule:: cherrypy.process.plugins
-
-.. autoclass:: SignalHandler
- :members:
-
-
-.. index:: Windows, Ctrl-C, shutdown
-.. _windows-console:
-
-Windows Console Events
-======================
-
-Microsoft Windows uses console events to communicate some signals, like Ctrl-C.
-When deploying CherryPy on Windows platforms, you should obtain the
-`Python for Windows Extensions <http://sourceforge.net/projects/pywin32/>`_;
-once you have them installed, CherryPy will handle Ctrl-C and other
-console events (CTRL_C_EVENT, CTRL_LOGOFF_EVENT, CTRL_BREAK_EVENT,
-CTRL_SHUTDOWN_EVENT, and CTRL_CLOSE_EVENT) automatically, shutting down the
-bus in preparation for process exit.
-
diff --git a/sphinx/source/refman/process/servers.rst b/sphinx/source/refman/process/servers.rst
deleted file mode 100644
index 902ab12a..00000000
--- a/sphinx/source/refman/process/servers.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-**********************************************************
-:mod:`cherrypy.process.servers` -- HTTP Server interfaces
-**********************************************************
-
-.. automodule:: cherrypy.process.servers
-
-
-Classes
-=======
-
-.. autoclass:: ServerAdapter
- :members:
-
-.. autoclass:: FlupFCGIServer
- :members:
-
-.. autoclass:: FlupSCGIServer
- :members:
-
-
-Functions
-=========
-
-.. autofunction:: client_host
-
-.. autofunction:: check_port
-
-.. autofunction:: wait_for_free_port
-
-.. autofunction:: wait_for_occupied_port
-
diff --git a/sphinx/source/refman/process/win32.rst b/sphinx/source/refman/process/win32.rst
deleted file mode 100644
index 20a3b3e4..00000000
--- a/sphinx/source/refman/process/win32.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-**********************************************************
-:mod:`cherrypy.process.win32` -- Bus support for Windows
-**********************************************************
-
-.. automodule:: cherrypy.process.win32
-
-Classes
-=======
-
-.. autoclass:: ConsoleCtrlHandler
- :members:
-
-.. autoclass:: Win32Bus
- :members:
-
-.. autoclass:: PyWebService
- :members:
diff --git a/sphinx/source/refman/process/wspbus.rst b/sphinx/source/refman/process/wspbus.rst
deleted file mode 100644
index 95799a52..00000000
--- a/sphinx/source/refman/process/wspbus.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-**********************************************************
-:mod:`cherrypy.process.wspbus` -- The Web Site Process Bus
-**********************************************************
-
-.. automodule:: cherrypy.process.wspbus
-
-Classes
-=======
-
-.. autoclass:: ChannelFailures
- :members:
-
-.. autoclass:: Bus
- :members:
-
diff --git a/sphinx/source/refman/wsgiserver/index.rst b/sphinx/source/refman/wsgiserver/index.rst
deleted file mode 100644
index ded4f516..00000000
--- a/sphinx/source/refman/wsgiserver/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-*******************
-cherrypy.wsgiserver
-*******************
-
-.. toctree::
- :glob:
-
- *
-
diff --git a/sphinx/source/refman/wsgiserver/init.rst b/sphinx/source/refman/wsgiserver/init.rst
deleted file mode 100644
index 444e7f69..00000000
--- a/sphinx/source/refman/wsgiserver/init.rst
+++ /dev/null
@@ -1,84 +0,0 @@
-*****************************************
-:mod:`cherrypy.wsgiserver` -- WSGI Server
-*****************************************
-
-.. automodule:: cherrypy.wsgiserver
-
-
-HTTP
-====
-
-.. autoclass:: HTTPRequest
- :members:
-
-.. autoclass:: HTTPConnection
- :members:
-
-.. autoclass:: HTTPServer
- :members:
-
-
-Request Entities
-================
-
-.. autoclass:: SizeCheckWrapper
- :members:
-
-.. autoclass:: KnownLengthRFile
- :members:
-
-.. autoclass:: ChunkedRFile
- :members:
-
-.. autoclass:: CP_fileobject
- :members:
-
-Exceptions
-==========
-
-.. autoclass:: MaxSizeExceeded
- :members:
-
-.. autoclass:: NoSSLError
- :members:
-
-.. autoclass:: FatalSSLAlert
- :members:
-
-
-Thread Pool
-===========
-
-.. autoclass:: WorkerThread
- :members:
-
-.. autoclass:: ThreadPool
- :members:
-
-SSL
-===
-
-.. autoclass:: SSLAdapter
- :members:
-
-WSGI
-====
-
-.. autoclass:: CherryPyWSGIServer
- :members:
-
-.. autoclass:: Gateway
- :members:
-
-.. autoclass:: WSGIGateway
- :members:
-
-.. autoclass:: WSGIGateway_10
- :members:
-
-.. autoclass:: WSGIGateway_u0
- :members:
-
-.. autoclass:: WSGIPathInfoDispatcher
- :members:
-
diff --git a/sphinx/source/refman/wsgiserver/ssl_builtin.rst b/sphinx/source/refman/wsgiserver/ssl_builtin.rst
deleted file mode 100644
index ab2aa7ab..00000000
--- a/sphinx/source/refman/wsgiserver/ssl_builtin.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-*****************************************************
-:mod:`cherrypy.wsgiserver.ssl_builtin` -- Builtin SSL
-*****************************************************
-
-.. automodule:: cherrypy.wsgiserver.ssl_builtin
-
-Classes
-=======
-
-.. autoclass:: BuiltinSSLAdapter
- :members:
-
diff --git a/sphinx/source/refman/wsgiserver/ssl_pyopenssl.rst b/sphinx/source/refman/wsgiserver/ssl_pyopenssl.rst
deleted file mode 100644
index f80a5580..00000000
--- a/sphinx/source/refman/wsgiserver/ssl_pyopenssl.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-*****************************************************
-:mod:`cherrypy.wsgiserver.ssl_pyopenssl` -- pyOpenSSL
-*****************************************************
-
-.. automodule:: cherrypy.wsgiserver.ssl_pyopenssl
-
-Classes
-=======
-
-.. autoclass:: SSL_fileobject
- :members:
-
-.. autoclass:: SSLConnection
- :members:
-
-.. autoclass:: pyOpenSSLAdapter
- :members:
-
diff --git a/sphinx/source/tutorial/REST.rst b/sphinx/source/tutorial/REST.rst
deleted file mode 100644
index 8a91a506..00000000
--- a/sphinx/source/tutorial/REST.rst
+++ /dev/null
@@ -1,308 +0,0 @@
-**********************
-Creating a RESTful API
-**********************
-
-`REST <http://en.wikipedia.org/wiki/Representational_state_transfer>`_ is an elegant architecture concept which is widely used nowadays.
-
-The point is quite simple: rely on HTTP methods and statuses and associate them with actual data manipulations.
-
-You can read more theory on the :doc:`../progguide/REST` page.
-
-Overview
-========
-
-In this tutorial, we will create a RESTful backend for a song collection management web app.
-
-A song is a *resource* with certain data (called *state*). Let's assume, every song has **title** and **artist**, and is identified by a unique **ID**.
-
-There are also *methods* to view and change the state of a resource. The basic set of methods is called `CRUD <http://en.wikipedia.org/wiki/Create,_read,_update_and_delete>`_—Create, Read, Update, and Delete.
-
-Let's assume that the frontend part is developed by someone else, and can interact with our backend part only with API requests. Our jobs is only to handle those requests, perform actions, and return the proper response.
-
-Therefore, we will not take care about templating or page rendering.
-
-We will also not use a database in this tutorial for the sake of concentrating solely on the RESTful API concept.
-
-.. note::
-
- REST principles assume that a response status must always be meaningful. HTTP 1.1 specification already has all necessary error codes, and a developer should properly map erroneous backend events with according HTTP error codes.
-
- Fortunately, CherryPy has done it for us. For instance, if our backend app receives a request with wrong parameters, CherryPy will raise a ``400 Bad Request`` response automatically.
-
-Download the :download:`complete example file <files/songs.py>`.
-
-Getting Started
-===============
-
-Create a file called ``songs.py`` with the following content::
-
- import cherrypy
-
- songs = {
- '1': {
- 'title': 'Lumberjack Song',
- 'artist': 'Canadian Guard Choir'
- },
-
- '2': {
- 'title': 'Always Look On the Bright Side of Life',
- 'artist': 'Eric Idle'
- },
-
- '3': {
- 'title': 'Spam Spam Spam',
- 'artist': 'Monty Python'
- }
- }
-
- class Songs:
-
- exposed = True
-
- if __name__ == '__main__':
-
- cherrypy.tree.mount(
- Songs(), '/api/songs',
- {'/':
- {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
- }
- )
-
- cherrypy.engine.start()
- cherrypy.engine.block()
-
-Let's go through this code line by line.
-
-Import CherryPy::
-
- import cherrypy
-
-Define the song "database", which is a simple Python dictionary::
-
- songs = {
- '1': {
- 'title': 'Lumberjack Song',
- 'artist': 'Canadian Guard Choir'
- },
-
- '2': {
- 'title': 'Always Look On the Bright Side of Life',
- 'artist': 'Eric Idle'
- },
-
- '3': {
- 'title': 'Spam Spam Spam',
- 'artist': 'Monty Python'
- }
- }
-
-Note that we are using *strings* as dict keys, not *integers*. This is done only to avoid extra type convertings when we will parse the request parameters (which are always strings.) Normally, the ID handling is performed by a database automatically, but since we do not use any, we have to deal with it manually.
-
-Create a class to represent the *songs* resource::
-
- class Songs:
-
-Expose all the (future) class methods at once::
-
- exposed = True
-
-Standard Python check on whether the file is used directly or as module::
-
- if __name__ == '__main__':
-
-Create an instance of the class (called a CherryPy application) and mount it to ``/api/songs``::
-
- cherrypy.tree.mount(
- Songs(), '/api/songs',
-
-This means that this app will handle requests coming to the URLs starting with ``/api/songs``.
-
-Now, here goes the interesting part.
-
-CherryPy has a very helpful tool for creating RESTful APIs—the **MethodDispatcher**.
-
-Learn it and love it.
-
-Briefly speaking, it is a special sort of dispatcher which automatically connects the HTTP requests to the according handlers based on the request method. All you have to do is just name the handlers to correspond to the HTTP method names.
-
-Long story short, just call the HTTP GET handler ``GET``, and the HTTP POST handle ``POST``.
-
-Activate this dispatcher for our app::
-
- {'/':
- {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
- }
- )
-
-Note that the ``/`` path in this config is relative to the application mount point (``/api/songs``), and will apply only to it.
-
-The last 2 lines do just the same as the ``quickstart`` method, only written a bit more explicitly—run the server::
-
- cherrypy.engine.start()
- cherrypy.engine.block()
-
-GET
-===
-
-Represents the Read method in CRUD.
-
-Add a new method to the ``Songs`` class in ``songs.py``, called ``GET``::
-
- def GET(self, id=None):
-
- if id == None:
- return('Here are all the songs we have: %s' % songs)
- elif id in songs:
- song = songs[id]
- return('Song with the ID %s is called %s, and the artist is %s' % (id, song['title'], song['artist']))
- else:
- return('No song with the ID %s :-(' % id)
-
-This method will return the whole song dictionary if the ID is not specified (``/api/songs``), a particular song data if the ID is specified and exists (``/api/songs/1`` ), and the message about a not existing song otherwise (``/api/songs/42``.)
-
-Try it out in your browser by going to ``127.0.0.1:8080/api/songs/``, ``127.0.0.1:8080/api/songs/1``, or ``127.0.0.1:8080/api/songs/42``.
-
-POST
-====
-
-Represents the Create method in CRUD.
-
-Add a new method to the ``Songs`` class, called ``POST``::
-
- def POST(self, title, artist):
-
- id = str(max([int(_) for _ in songs.keys()]) + 1)
-
- songs[id] = {
- 'title': title,
- 'artist': artist
- }
-
- return ('Create a new song with the ID: %s' % id)
-
-This method defines the next unique ID and adds an item to the ``songs`` dictionary.
-
-Note that we do not validate the input arguments. CherryPy does it for us. If any parameter is missing or and extra one is provided, the 400 Bad Request error will be raised automatically.
-
-.. note::
-
- Unlike GET request, POST, PUT, and DELETE requests cannot be sent via the browser URL promt.
-
- You will need to use some special software to do it.
-
- The recommendation here is to use `cURL <http://en.wikipedia.org/wiki/CURL>`_, which is available by default in most GNU/Linux distributions and is available for Windows and Mac.
-
- Basic cURL usage to send a request, applied in the examples below, is as follows:
-
- .. code-block:: bash
-
- curl -d <param1>=<value1> -d <param2>=<value2> -X <HTTPMethod> <URL>
-
- You can send GET requests with cURL too, but using a browser is easier.
-
-Send a POST HTTP request to ``127.0.0.1:8080/api/songs/`` with cURL:
-
-.. code-block:: bash
-
- curl -d title='Frozen' -d artist='Madonna' -X POST '127.0.0.1:8080/api/songs/'
-
-You will see the response:
-
- Create a new song with the ID: 4%
-
-Now, if you go to ``127.0.0.1:8080/api/songs/4`` in your browser you will se the following message:
-
- Song with the ID 4 is called Frozen, and the artist is Madonna
-
-So it actually works!
-
-PUT
-===
-
-Represents the Update method in CRUD.
-
-Add a new method to the ``Songs`` class, called ``PUT``::
-
- def PUT(self, id, title=None, artist=None):
- if id in songs:
- song = songs['id']
-
- song['title'] = title or song['title']
- song['artist'] = artist or song['artist']
-
- return('Song with the ID %s is now called %s, and the artist is now %s' % (id, song['title'], song['artist']))
- else:
- return('No song with the ID %s :-(' % id)
-
-This method checks whether the requested song exists and updates the fields that are provided. If some field is not specified, the corresponding value will not be updated.
-
-Try sending some PUT HTTP requests to ``127.0.0.1:8080/api/songs/3`` via cURL, and check the result by requesting ``127.0.0.1:8080/api/songs/4`` in your browser:
-
-* .. code-block:: bash
-
- curl -d title='Yesterday' -X PUT '127.0.0.1:8080/api/songs/3'
-
- The response:
-
- Song with the ID 3 is now called Yesterday, and the artist is now Monty Python%
-
- What you'll see in the browser:
-
- Song with the ID 3 is called Yesterday, and the artist is Monty Python
-
-* .. code-block:: bash
-
- curl -d artist='Beatles' -X PUT '127.0.0.1:8080/api/songs/3'
-
- The response:
-
- Song with the ID 3 is now called Yesterday, and the artist is now Beatles%
-
- What you'll see in the browser:
-
- Song with the ID 3 is called Yesterday, and the artist is Beatles
-
-DELETE
-======
-
-Represents the DELETE method in CRUD.
-
-Add a new method to the ``Songs`` class, called ``DELETE``::
-
- def DELETE(self, id):
- if id in songs:
- songs.pop(id)
-
- return('Song with the ID %s has been deleted.' % id)
- else:
- return('No song with the ID %s :-(' % id)
-
-This method, like the previous ones, check if the given ID point to an existing song and pops it out of the ``songs`` dictionary.
-
-Send a DELETE HTTP request to ``127.0.0.1:8080/api/songs/2`` via cURL:
-
-.. code-block:: bash
-
- curl -X DELETE '127.0.0.1:8080/api/songs/2'
-
-The response:
-
- Song with the ID 2 has been deleted.%
-
-And the browser output:
-
- No song with the ID 2 :-(
-
-Multiple Resources
-==================
-
-You can have any number of resources represented this way. Each resource is a CherryPy application, i.e. a class.
-
-For another resource, say, *users*, just create a class ``Users`` the same way you created ``Songs``, and mount it to ``/api/users`` with the same config.
-
-Conclusion and Further Steps
-============================
-
-This is pretty much it about the logic of REST API in CherryPy.
-
-You can now add actual database manipulations, parameter validation, and whatever your project may require.
diff --git a/sphinx/source/tutorial/basics.rst b/sphinx/source/tutorial/basics.rst
deleted file mode 100644
index 3fc9f6bf..00000000
--- a/sphinx/source/tutorial/basics.rst
+++ /dev/null
@@ -1,148 +0,0 @@
-*******************************
-Your first CherryPy application
-*******************************
-
-The standard 'Hello world!' application takes less than 10 lines of code
-when written using CherryPy::
-
- import cherrypy
-
-
- class HelloWorld(object):
- def index(self):
- return "Hello world!"
- index.exposed = True
-
- cherrypy.quickstart(HelloWorld())
-
-We assume that you already have :doc:`installed </intro/install>` CherryPy.
-Copy the file above and save it locally as ``hello.py``, then start the
-application at the command prompt::
-
- $ python hello.py
-
-Direct your favorite web browser to http://localhost:8080 and you should
-see ``Hello world!`` printed there.
-
-How does it work?
------------------
-
-Let's take a look at ``hello.py``:
-
- * The ``import cherrypy`` statement imports the main CherryPy module.
- This is all that is required to have CherryPy working. Feel free to
- "import cherrypy" in an interactive session and see what's available!
- ``help(cherrypy)`` is also quite useful.
- * We declare a class named ``HelloWorld``. An instance of this class is the
- object that will be published by CherryPy. It contains a single method,
- named ``index``, which will get called when the root URL for the site is
- requested (for example, ``http://localhost/``). This method returns the
- **contents** of the Web page; in this case, the ``'Hello World!'`` string.
- Note that you don't have to subclass any framework-provided classes; in fact,
- you don't even have to use classes at all! But let's start with them for now.
- * The ``index.exposed = True`` is a necessary step to tell CherryPy that the
- ``index()`` method will be **exposed**. Only exposed methods can be called
- to answer a request. This feature allows the user to select which methods
- of an object will be accessible via the Web; non-exposed methods can't be
- accessed. Another way to **expose** a method is to use the decorator
- :func:`cherrypy.expose`.
- * ``cherrypy.quickstart(HelloWorld())`` mounts an instance of the HelloWorld
- class, and starts the embedded webserver. It runs until explicitly
- interrupted, either with ``Ctrl-C`` or via a suitable signal (a simple
- ``kill`` on Unix will do it).
-
-When the application is executed, the CherryPy server is started with the
-default configuration. It will listen on ``localhost`` at port ``8080``. These
-defaults can be overridden by using a :doc:`configuration file </tutorial/config>` or dictionary
-(more on this later).
-
-Finally, the web server receives the request for the URL
-``http://localhost:8080``. It searches for the best method to handle the
-request, starting from the ``HelloWorld`` instance. In this particular case,
-the root of the site is automatically mapped to the ``index()`` method (similar
-to the ``index.html`` that is the standard page for conventional Web servers).
-The HelloWorld class defines an ``index()`` method and exposes it. CherryPy
-calls ``HelloWorld().index()``, and the result of the call is sent back to
-the browser as the contents of the index page for the website. All the
-dispatching and HTTP-processing work is
-done automatically; the application programmer only needs to provide the
-desired content as the return value of the ``index`` method.
-
-CherryPy structure
-------------------
-
-Most of the features of CherryPy are available through the :mod:`cherrypy`
-module. It contains several members:
-
- * :class:`cherrypy.engine <cherrypy.process.wspbus.Bus>`
- controls process startup, shutdown, and other events, including your own
- Plugins. See :doc:`/tutorial/engine`.
- * :class:`cherrypy.server <cherrypy._cpserver.Server>` configures and controls
- the HTTP server.
- * :class:`cherrypy.request <cherrypy._cprequest.Request>` contains all
- the information that comes with the HTTP request, after it is parsed and
- analyzed by CherryPy.
- * :attr:`cherrypy.request.headers <cherrypy.lib.httputil.HeaderMap>`
- contains a mapping with the header options that were sent as part of
- the request.
- * :class:`cherrypy.session <cherrypy.lib.sessions.Session>` is a special
- mapping that is automatically generated and encoded by CherryPy; it can
- be used to store session-data in a persistent cookie. For it to work you
- have to enable the session functionality by setting 'tools.session.on' to
- True in your :doc:`config </tutorial/config>`.
- * :class:`cherrypy.response <cherrypy._cprequest.Response>` contains the
- data that is used to build the HTTP response.
- * :attr:`cherrypy.response.headers <cherrypy.lib.httputil.HeaderMap>`
- contains a mapping with the header options that will be returned by the
- server, before the contents get sent.
- * :attr:`cherrypy.response.body <cherrypy._cprequest.Response.body>` contains
- the actual contents of the webpage that will be sent as a response.
-
-CherryPy Response
------------------
-
-The :class:`cherrypy.response <cherrypy._cprequest.Response>` object is
-available to affect aspects of the response
-to a request. Like the request, the response object is a thread-local,
-meaning although it appears to be a global variable, its value is specific
-to the current thread, and thus the current request.
-
-One may store arbitrary data in the response object.
-
-HTTP Headers
-------------
-
-CherryPy exposes the :attr:`request headers <cherrypy.lib.httputil.HeaderMap>`
-(as sent from the client), and response headers (to be returned in the
-response) in the `headers` attribute of `cherrypy.request` and
-`cherrypy.response`.
-
-For example, to find out what "host" to which the client intended to connect::
-
- import cherrypy
-
-
- class HelloWorld(object):
- @cherrypy.expose
- def index(self):
- host = cherrypy.request.headers['Host']
- return "You have successfully reached " + host
-
- cherrypy.quickstart(HelloWorld())
-
-Or to set headers on the response::
-
- import cherrypy
-
-
- class HelloWorld(object):
- def _get_jpeg_data(self):
- """This method should return the jpeg data"""
- return ""
-
- @cherrypy.expose
- def index(self):
- cherrypy.response.headers['Content-Type'] = 'application/jpeg'
- return self._get_jpeg_data()
-
- cherrypy.quickstart(HelloWorld())
diff --git a/sphinx/source/tutorial/dispatching.rst b/sphinx/source/tutorial/dispatching.rst
deleted file mode 100644
index fb39a8c2..00000000
--- a/sphinx/source/tutorial/dispatching.rst
+++ /dev/null
@@ -1,433 +0,0 @@
-***********
-Dispatching
-***********
-
- The resource is not the storage object. The resource is not a mechanism
- that the server uses to handle the storage object. The resource is a
- conceptual mapping -- the server receives the identifier (which identifies
- the mapping) and applies it to its current mapping implementation (usually
- a combination of collection-specific deep tree traversal and/or hash tables)
- to find the currently responsible handler implementation and the handler
- implementation then selects the appropriate action+response based on the
- request content. All of these implementation-specific issues are hidden
- behind the Web interface; their nature cannot be assumed by a client that
- only has access through the Web interface.
-
- `Roy Fielding <http://www.ics.uci.edu/~fielding/pubs/dissertation/evaluation.htm>`_
-
-When you wish to serve a resource on the Web, you never actually serve the
-resource, because "resources" are concepts. What you serve are representations
-of a resource, and *page handlers* are what you use in CherryPy to do that.
-Page handlers are functions that you write; CherryPy calls one for each
-request and uses its response (a string of HTML, for example) as the
-representation.
-
-For the user, a web application is just like a website with static files.
-The user types (or clicks) a URL, and gets to the desired webpage. A
-conventional webserver uses the URL to retrieve a static file from the
-filesystem. A web application server, on the other hand, not only serves
-the content from static files; it can also map the URL it receives into some
-object and call it. The result is then sent back to the user's browser,
-where it is rendered into a viewable page. The result is a dynamic web
-application; for each URL, a unique object can be called into action.
-The key to understand how to write a new web application is to understand
-how this mapping occurs.
-
-CherryPy takes the output of the appropriate page handler function, binds it
-to :attr:`cherrypy.response.body <cherrypy._cprequest.Response.body>`,
-and sends it as the HTTP response entity
-body. Your page handler function (and almost any other part of CherryPy) can
-directly set :attr:`cherrypy.response.status <cherrypy._cprequest.Response.status>`
-and :attr:`cherrypy.response.headers <cherrypy._cprequest.Response.headers>`
-as desired.
-
-Dispatchers
-===========
-
-Before CherryPy can call your page handlers, it has to know 1) where they are,
-and 2) which one to call for a given 'identifier' (URI). In CherryPy, we use
-a Dispatcher object to:
-
-1. Understand the arrangement of handlers
-2. Find the appropriate page handler function
-3. Wrap your actual handler function in a
- :class:`PageHandler <cherrypy._cpdispatch.PageHandler>` object (see below)
-4. Set :attr:`cherrypy.request.handler <cherrypy._cprequest.Request.handler>`
- (to the :class:`PageHandler <cherrypy._cpdispatch.PageHandler>` wrapper)
-5. Collect configuration entries into
- :attr:`cherrypy.request.config <cherrypy._cprequest.Request.config>`
-6. Collect "virtual path" components
-
-CherryPy has a default arrangement of handlers (see next), but also allows you
-to trade it for any arrangement you can think up and implement.
-
-.. _defaultdispatcher:
-
-Default Dispatcher
-------------------
-
-By default, CherryPy uses a fairly straightforward mapping procedure. The root
-of the site is the :attr:`Application.root <cherrypy._cptree.Application.root>`
-object. When it receives a URL, it breaks it into its path components, and
-proceeds looking down into the site until it finds an object that is the
-'best match' for that particular URL. For each path component it tries to find
-an object with the same name, starting from ``root``, and going down for each
-component it finds, until it can't find a match. An example shows it better::
-
- root = HelloWorld()
- root.onepage = OnePage()
- root.otherpage = OtherPage()
-
-In the example above, the URL ``http://localhost/onepage`` will point at the
-first object and the URL ``http://localhost/otherpage`` will point at the
-second one. As usual, this search is done automatically. But it goes even further::
-
- root.some = Page()
- root.some.page = Page()
-
-In this example, the URL ``http://localhost/some/page`` will be mapped to the
-``root.some.page`` object. If this object is exposed (or alternatively, its
-``index`` method is), it will be called for that URL.
-
-In our HelloWorld example, adding the ``http://localhost/onepage/`` mapping
-to ``OnePage().index`` could be done like this::
-
- import cherrypy
-
-
- class OnePage(object):
- def index(self):
- return "one page!"
- index.exposed = True
-
-
- class HelloWorld(object):
- onepage = OnePage()
-
- def index(self):
- return "hello world"
- index.exposed = True
-
- cherrypy.quickstart(HelloWorld())
-
-Normal methods
-^^^^^^^^^^^^^^^
-
-.. index:: methods; normal
-
-CherryPy can directly call methods on the mounted objects, if it receives a
-URL that is directly mapped to them. For example::
-
-
- """This example can handle the URIs
- / -> OnePage.index
- /foo -> OnePage.foo -> foo
- """
- import cherrypy
-
-
- class OnePage(object):
- def index(self):
- return "one page!"
- index.exposed = True
-
-
- def foo():
- return 'Foo!'
- foo.exposed = True
-
- if __name__ == '__main__':
- root = OnePage()
- root.foo = foo
- cherrypy.quickstart(root)
-
-
-In the example, ``root.foo`` contains a function object, named ``foo``. When
-CherryPy receives a request for the ``/foo`` URL, it will automatically call
-the ``foo()`` function. Note that it can be a plain function, or a method of
-any object; any callable will do it.
-
-.. _indexmethods:
-
-Index methods
-^^^^^^^^^^^^^
-
-.. index:: index, methods; index
-
-The ``index`` method has a special role in CherryPy: it handles intermediate
-URI's that end in a slash; for example, the URI ``/orders/items/`` might map
-to ``root.orders.items.index``. The ``index`` method can take additional
-keyword arguments if the request includes querystring or POST params; see
-:ref:`kwargs`, next. However,
-unlike all other page handlers, it *cannot* take positional arguments (see
-:ref:`args`, below).
-
-The default dispatcher will always try to find a method named `index` at the
-end of the branch traversal. In the example above, the URI "/onepage/" would
-result in the call: ``app.root.onepage.index()``. Depending on the use of the
-:func:`trailing_slash Tool <cherrypy.lib.cptools.trailing_slash>`,
-that might be interrupted with an HTTPRedirect, but
-otherwise, both ``"/onepage"`` (no trailing slash) and ``"/onepage/"``
-(trailing slash) will result in the same call.
-
-.. _kwargs:
-
-Keyword Arguments
-^^^^^^^^^^^^^^^^^
-
-.. index:: forms, **kwargs
-
-Any page handler that is called by CherryPy (``index``, or any other suitable
-method) can receive additional data from HTML or other forms using
-*keyword arguments*. For example, the following login form sends the
-``username`` and the ``password`` as form arguments using the POST method::
-
- <form action="doLogin" method="post">
- <p>Username</p>
- <input type="text" name="username" value=""
- size="15" maxlength="40"/>
- <p>Password</p>
- <input type="password" name="password" value=""
- size="10" maxlength="40"/>
- <p><input type="submit" value="Login"/></p>
- <p><input type="reset" value="Clear"/></p>
- </form>
-
-The following code can be used to handle this URL::
-
- class Root(object):
- def doLogin(self, username=None, password=None):
- """Check the username & password"""
- doLogin.exposed = True
-
-Both arguments have to be declared as *keyword arguments*. The default value
-can be used either to provide a suitable default value for optional arguments,
-or to provide means for the application to detect if some values were missing
-from the request.
-
-CherryPy supports both the GET and POST method for HTML forms. Arguments are
-passed the same way, regardless of the original method used by the browser to
-send data to the web server.
-
-.. _args:
-
-Positional Arguments
-^^^^^^^^^^^^^^^^^^^^
-
-.. index:: path, virtual path, path segments, *args, positional arguments
-
-When a request is processed, the URI is split into its components, and each
-one is matched in order against the nodes in the tree. Any trailing components
-are "virtual path" components and are passed as positional arguments. For
-example, the URI ``"/branch/leaf/4"`` might result in
-the call: ``app.root.branch.leaf(4)``, or ``app.root.index(branch, leaf, 4)``
-depending on how you have your handlers arranged.
-
-Partial matches can happen when a URL contains components that do not map to
-the object tree. This can happen for a number of reasons. For example, it may
-be an error; the user just typed the wrong URL. But it also can mean that the
-URL contains extra arguments.
-
-For example, assume that you have a blog-like application written in CherryPy
-that takes the year, month and day as part of the URL
-``http://localhost/blog/2005/01/17``. This URL can be handled by the
-following code::
-
- class Root(object):
- def blog(self, year, month, day):
- """Deliver the blog post. According to *year* *month* *day*.
- """
- blog.exposed = True
-
- root = Root()
-
-So the URL above will be mapped as a call to::
-
- root.blog('2005', '01', '17')
-
-In this case, there is a partial match up to the ``blog`` component. The rest
-of the URL can't be found in the mounted object tree. In this case, the
-``blog()`` method will be called, and the positional parameters will
-receive the remaining path segments as arguments. The values are passed as
-strings; in the above mentioned example, the arguments would still need to be
-converted back into numbers, but the idea is correctly presented.
-
-.. _defaultmethods:
-
-Default methods
-^^^^^^^^^^^^^^^
-
-.. index:: default, methods; default
-
-If the default dispatcher is not able to locate a suitable page handler by
-walking down the tree, it has a last-ditch option: it starts walking back
-''up'' the tree looking for `default` methods. Default methods work just like
-any other method with positional arguments, but are defined one level further
-down, in case you have multiple methods to expose. For example, we could have
-written the above "blog" example equivalently with a "default" method instead::
-
- class Blog(object):
- def default(self, year, month, day):
- """This method catch the positional arguments
- *year*,*month*,*day* to delivery the blog content.
- """
- default.exposed = True
-
-
- class Root(object):
- pass
-
- root = Root()
- root.blog = Blog()
-
-So the URL ``http://localhost/blog/2005/01/17`` will be mapped as a call to::
-
- root.blog.default('2005', '01', '17')
-
-You could achieve the same effect by defining a ``__call__`` method in this
-case, but "default" just reads better. ;)
-
-Special characters
-^^^^^^^^^^^^^^^^^^
-
-You can use dots in a URI like ``/path/to/my.html``, but Python method names
-don't allow dots. To work around this, the default dispatcher converts all dots
-in the URI to underscores before trying to find the page handler. In the
-example, therefore, you would name your page handler "def my_html". However,
-this means the page is also available at the URI ``/path/to/my_html``.
-If you need to protect the resource (e.g. with authentication), **you must
-protect both URLs**.
-
-.. versionadded:: 3.2
- The default dispatcher now takes a 'translate' argument, which converts all
- characters in string.punctuation to underscores using the builtin
- :meth:`str.translate <str.translate>` method of string objects.
- You are free to specify any other translation string of length 256.
-
-Other Dispatchers
------------------
-
-But Mr. Fielding mentions two kinds of "mapping implementations" above: trees
-and hash tables ('dicts' in Python). Some web developers claim trees are
-difficult to change as an application evolves, and prefer to use dicts
-(or a list of tuples) instead. Under these schemes, the mapping key is often
-a regular expression, and the value is the handler function. For example::
-
- def root_index(name):
- return "Hello, %s!" % name
-
- def branch_leaf(size):
- return str(int(size) + 3)
-
- mappings = [
- (r'^/([^/]+)$', root_index),
- (r'^/branch/leaf/(\d+)$', branch_leaf),
- ]
-
-CherryPy allows you to use a :class:`Dispatcher<cherrypy._cpdispatch.Dispatcher>`
-other than the default if you wish. By using another
-:class:`Dispatcher <cherrypy._cpdispatch.Dispatcher>` (or writing your own),
-you gain complete control over the arrangement and behavior of your page
-handlers (and config). To use another dispatcher, set the
-``request.dispatch`` config entry to the dispatcher you like::
-
- d = cherrypy.dispatch.RoutesDispatcher()
- d.connect(name='hounslow', route='hounslow', controller=City('Hounslow'))
- d.connect(name='surbiton', route='surbiton', controller=City('Surbiton'),
- action='index', conditions=dict(method=['GET']))
- d.mapper.connect('surbiton', controller='surbiton',
- action='update', conditions=dict(method=['POST']))
-
- conf = {'/': {'request.dispatch': d}}
- cherrypy.tree.mount(root=None, config=conf)
-
-A couple of notes about the example above:
-
-* Since Routes has no controller hierarchy, there's nothing to pass as a
- root to :func:`cherrypy.tree.mount <cherrypy._cptree.Tree.mount>`;
- pass ``None`` in this case.
-* Usually you'll use the same dispatcher for an entire app, so specifying it
- at the root ("/") is common. But you can use different dispatchers for
- different paths if you like.
-* Because the dispatcher is so critical to finding handlers (and their
- ancestors), this is one of the few cases where you *cannot* use
- :ref:`_cp_config <cp_config>`; it's a chicken-and-egg problem:
- you can't ask a handler you haven't found yet how it wants to be found.
-* Since Routes are explicit, there's no need to set the ``exposed`` attribute.
- **All routes are always exposed.**
-
-CherryPy ships with additional Dispatchers in :mod:`cherrypy._cpdispatch`.
-
-.. _pagehandlers:
-
-PageHandler Objects
-===================
-
-Because the Dispatcher sets
-:attr:`cherrypy.request.handler <cherrypy._cprequest.Request.handler>`,
-it can also control
-the input and output of that handler function by wrapping the actual handler.
-The default Dispatcher passes "virtual path" components as positional arguments
-and passes query-string and entity (GET and POST) parameters as keyword
-arguments. It uses a :class:`PageHandler <cherrypy._cpdispatch.PageHandler>`
-object for this, which looks a lot like::
-
- class PageHandler(object):
- """Callable which sets response.body."""
-
- def __init__(self, callable, *args, **kwargs):
- self.callable = callable
- self.args = args
- self.kwargs = kwargs
-
- def __call__(self):
- return self.callable(*self.args, **self.kwargs)
-
-The actual default PageHandler is a little bit more complicated (because the
-args and kwargs are bound later), but you get the idea. And you can see how
-easy it would be to provide your own behavior, whether your own inputs or your
-own way of modifying the output. Remember, whatever is returned from the
-handler will be bound to
-:attr:`cherrypy.response.body <cherrypy._cprequest.Response.body>` and will
-be used as the response entity.
-
-Replacing page handlers
------------------------
-
-The handler that's going to be called during a request is available at
-:attr:`cherrypy.request.handler <cherrypy._cprequest.Request.handler>`,
-which means your code has a chance to replace it before the handler runs.
-It's a snap to write a Tool to do so with a
-:class:`HandlerWrapperTool <cherrypy._cptools.HandlerWrapperTool>`::
-
- to_skip = (KeyboardInterrupt, SystemException, cherrypy.HTTPRedirect)
- def PgSQLWrapper(next_handler, *args, **kwargs):
- trans.begin()
- try:
- result = next_handler(*args, **kwargs)
- trans.commit()
- except Exception, e:
- if not isinstance(e, to_skip):
- trans.rollback()
- raise
- trans.end()
- return result
-
- cherrypy.tools.pgsql = cherrypy._cptools.HandlerWrapperTool(PgSQLWrapper)
-
-Configuration
-=============
-
-The default arrangement of CherryPy handlers is a tree. This enables a very
-powerful configuration technique: config can be attached to a node in the tree
-and cascade down to all children of that node. Since the mapping of URI's to
-handlers is not always 1:1, this provides a flexibility which is not as easily
-definable in other, flatter arrangements.
-
-However, because the arrangement of config is directly related to the
-arrangement of handlers, it is the responsibility of the Dispatcher to collect
-per-handler config, merge it with per-URI and global config, and bind the
-resulting dict to :attr:`cherrypy.request.config <cherrypy._cprequest.Request.config>`.
-This dict is of depth 1 and will contain all config entries which are in
-effect for the current request.
-
diff --git a/sphinx/source/tutorial/engine.rst b/sphinx/source/tutorial/engine.rst
deleted file mode 100644
index ebb174ea..00000000
--- a/sphinx/source/tutorial/engine.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-*******************
-The CherryPy Engine
-*******************
-
-The :class:`cherrypy.engine<cherrypy.process.wspbus.Bus>` object contains and
-manages site-wide behavior: daemonization, HTTP server start/stop, process
-reload, signal handling, drop privileges, PID file management, logging for
-all of these, and many more.
-
-Any task that needs to happen outside of the request process is managed by
-the Engine via *Plugins*. You can add your own site-wide
-behaviors, too; see :doc:`/progguide/extending/customplugins`. The Engine
-handles these tasks whether you start your site from a script, from an external
-server process like Apache, or via :doc:`cherryd</deployguide/cherryd>`.
-
-State Management
-================
-
-The Engine manages the *state* of the site. Engine methods like
-:func:`cherrypy.engine.start<cherrypy.process.wspbus.start>` move it
-from one state to another::
-
- O
- |
- V
- STOPPING --> STOPPED --> EXITING -> X
- A A |
- | \___ |
- | \ |
- | V V
- STARTED <-- STARTING
-
-Note in particular that the Engine allows you to stop and restart it again
-without stopping the process. This can be used to build highly dynamic sites,
-and is invaluable for debugging live servers.
-
-.. _channels:
-
-Channels
-========
-
-The Engine uses topic-based publish-subscribe messaging to manage event-driven
-behaviors like autoreload and daemonization. When the Engine moves from one
-state to another, it *publishes* a message on a *channel* named after the
-activity. For example, when you call
-:func:`cherrypy.engine.start<cherrypy.process.wspbus.start>`, the Engine
-moves from the STOPPED state to the STARTING state, publishes a message on
-the "start" *channel*, and then moves to the STARTED state.
-
-.. _plugins:
-
-Plugins
-=======
-
-Engine Plugins package up channel listeners into easy-to-use components.
-
-Engine Plugins have a :func:`subscribe<cherrypy.process.plugins.SimplePlugin.subscribe>`
-method which you can use to "turn them on"; that is, they will start listening
-for messages published on event channels. For example, to turn on PID file
-management::
-
- from cherrypy.process.plugins import PIDFile
- p = PIDFile(cherrypy.engine, "/var/run/myapp.pid")
- p.subscribe()
-
-If you want to turn off a plugin, call ``p.unsubscribe()``.
-
-The following builtin plugins are subscribed by default:
-
- * :doc:`Timeout Monitor</progguide/responsetimeouts>`
- * :class:`Autoreloader<cherrypy.process.plugins.Autoreloader>` (off in the "production" :ref:`environment<environments>`)
- * :class:`cherrypy.server<cherrypy._cpserver.Server>`
- * :class:`cherrypy.checker<cherrypy._cpchecker.Checker>`
- * :doc:`Engine log messages </refman/_cplogging>` go to :class:`cherrypy.log<cherrypy._GlobalLogManager>`.
- * A :class:`Signal Handler<cherrypy.process.plugins.SignalHandler>`.
-
diff --git a/sphinx/source/tutorial/exposing.rst b/sphinx/source/tutorial/exposing.rst
deleted file mode 100644
index 14ca5880..00000000
--- a/sphinx/source/tutorial/exposing.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-********
-Exposing
-********
-
-Any object that is attached to the root object is traversible via the internal
-URL-to-object mapping routine. However, it does not mean that the object itself
-is directly accessible via the Web. For this to happen, the object has to be
-**exposed**.
-
-Exposing objects
-----------------
-
-CherryPy maps URL requests to objects and invokes the suitable callable
-automatically. The callables that can be invoked as a result of external
-requests are said to be **exposed**.
-
-Objects are **exposed** in CherryPy by setting the ``exposed`` attribute.
-Most often, a method on an object is the callable that is to be invoked. In
-this case, one can directly set the exposed attribute::
-
- class Root(object):
- def index(self):
- """Handle the / URI"""
- index.exposed = True
-
-
-or use a decorator::
-
- class Root(object):
- @cherrypy.expose
- def index(self):
- """Handle the / URI"""
-
-
-When it is a special method, such as ``__call__``, that is to be invoked,
-the exposed attribute must be set on the class itself::
-
- class Node(object):
- exposed = True
- def __call__(self):
- """ """
-
-The techniques can be mixed, for example::
-
- """This example can handle the URIs:
- / -> Root.index
- /page -> Root.page
- /node -> Node.__call__
- """
- import cherrypy
-
-
- class Node(object):
- exposed = True
-
- def __call__(self):
- return "The node content"
-
-
- class Root(object):
-
- def __init__(self):
- self.node = Node()
-
- @cherrypy.expose
- def index(self):
- return "The index of the root object"
-
- def page(self):
- return 'This is the "page" content'
- page.exposed = True
-
-
- if __name__ == '__main__':
- cherrypy.quickstart(Root())
-
diff --git a/sphinx/source/tutorial/files/songs.py b/sphinx/source/tutorial/files/songs.py
deleted file mode 100644
index c8658b05..00000000
--- a/sphinx/source/tutorial/files/songs.py
+++ /dev/null
@@ -1,82 +0,0 @@
-import cherrypy
-
-songs = {
- '1': {
- 'title': 'Lumberjack Song',
- 'artist': 'Canadian Guard Choir'
- },
-
- '2': {
- 'title': 'Always Look On the Bright Side of Life',
- 'artist': 'Eric Idle'
- },
-
- '3': {
- 'title': 'Spam Spam Spam',
- 'artist': 'Monty Python'
- }
-}
-
-
-class Songs:
-
- exposed = True
-
- def GET(self, id=None):
-
- if id is None:
- return('Here are all the songs we have: %s' % songs)
- elif id in songs:
- song = songs[id]
-
- return(
- 'Song with the ID %s is called %s, and the artist is %s' % (
- id, song['title'], song['artist']))
- else:
- return('No song with the ID %s :-(' % id)
-
- def POST(self, title, artist):
-
- id = str(max([int(_) for _ in songs.keys()]) + 1)
-
- songs[id] = {
- 'title': title,
- 'artist': artist
- }
-
- return ('Create a new song with the ID: %s' % id)
-
- def PUT(self, id, title=None, artist=None):
- if id in songs:
- song = songs[id]
-
- song['title'] = title or song['title']
- song['artist'] = artist or song['artist']
-
- return(
- 'Song with the ID %s is now called %s, '
- 'and the artist is now %s' % (
- id, song['title'], song['artist'])
- )
- else:
- return('No song with the ID %s :-(' % id)
-
- def DELETE(self, id):
- if id in songs:
- songs.pop(id)
-
- return('Song with the ID %s has been deleted.' % id)
- else:
- return('No song with the ID %s :-(' % id)
-
-if __name__ == '__main__':
-
- cherrypy.tree.mount(
- Songs(), '/api/songs',
- {'/':
- {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
- }
- )
-
- cherrypy.engine.start()
- cherrypy.engine.block()
diff --git a/sphinx/source/tutorial/index.rst b/sphinx/source/tutorial/index.rst
deleted file mode 100644
index ea1615eb..00000000
--- a/sphinx/source/tutorial/index.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-********
-Tutorial
-********
-
-What is this tutorial about?
-============================
-
-This tutorial covers the basic steps for a newcomer to come to grips with
-CherryPy's unique approach to web application development. After following
-this tutorial, you will be able to understand how CherryPy
-applications work, and also to implement simple but yet powerful applications
-on your own. Some knowledge of the Python programming language is assumed.
-One does not need to be an expert to work with CherryPy, but a good
-understanding of object-oriented basics is strongly recommended.
-
-This tutorial only covers the basic features of CherryPy, but it tries to
-present them in a way that makes it easier for you to discover how to
-use them. The CherryPy distribution comes with several good tutorial applications;
-however, the best way to master CherryPy is to use it to write your own
-Web applications. The embedded web server makes it easy for anyone not only
-to try, but also to deploy local applications, or even small Internet-enabled
-web sites. Try it, and let us know what you did with it!
-
-Knowledge required
-------------------
-
-It is assumed that the user has:
-
- * Some knowledge of the Python programming language
- * Some experience with basic object oriented programming
- * Some knowledge of HTML, which is necessary to build the Web pages
-
-Learning Python
----------------
-
-As stated above, this is not a guide to the Python language. There are plenty of
-good resources for those learning Python (just to name a few among the best:
-`Learn Python The Hard Way <http://learnpythonthehardway.org/>`_,
-`A Byte Of Python <http://swaroopch.com/notes/python/>`_ and
-`Dive into Python <http://www.diveintopython.net/>`_).
-The `official Python website <http://www.python.org>`_ lists some good
-resources, including an excellent
-`tutorial <http://docs.python.org/tut/tut.html>`_.
-
-Start the Tutorial
-==================
-
-.. toctree::
- :maxdepth: 2
-
- basics
- exposing
- dispatching
- config
- tools
- engine
- REST
-
diff --git a/sphinx/source/tutorial/tools.rst b/sphinx/source/tutorial/tools.rst
deleted file mode 100644
index 9076b77f..00000000
--- a/sphinx/source/tutorial/tools.rst
+++ /dev/null
@@ -1,105 +0,0 @@
-*****
-Tools
-*****
-
-CherryPy core is extremely light and clean. It contains only the necessary
-features to support the HTTP protocol and to call the correct object for
-each request. Additional request-time features can be added to it using
-**modular tools**.
-
-Tools are a great way to package up behavior that happens outside your page
-handlers. A tool is an object that has a chance to work on a request as it
-goes through the usual CherryPy processing stages, both before and after it
-gets to your handler. Several tools are provided
-as part of the standard CherryPy library, available in
-:mod:`cherrypy.tools <cherrypy._cptools>`. See :doc:`/progguide/builtintools`.
-
-Tools provide a lot of flexibility. Different tools can be applied to different
-parts of the site, and the order of tools can be changed. The user can write
-custom tools for special applications, changing the behavior of CherryPy
-without the need to change its internals.
-See :doc:`/progguide/extending/customtools`.
-
-Using Tools
-===========
-
-Config Files
-------------
-
-You can turn on Tools in config, whether a file or a dict.
-For example, you can add static directory serving with the builtin
-``staticdir`` tool with just a few lines in your config file::
-
- [/docroot]
- tools.staticdir.on: True
- tools.staticdir.root: "/path/to/app"
- tools.staticdir.dir: 'static'
-
-This turns on the ``staticdir`` tool for all *URLs* that start with "/docroot".
-
-_cp_config
-----------
-
-You can also enable and configure tools *per controller* or *per handler*
-using :ref:`_cp_config <cp_config>`::
-
- class docroot(object):
-
- _cp_config = {'tools.staticdir.on': True,
- 'tools.staticdir.root: "/path/to/app",
- 'tools.staticdir.dir': 'static'}
-
-Decorators
-----------
-
-But we can do even better by using the **builtin decorator support** that all
-Tools have::
-
- class docroot(object):
-
- @tools.staticdir(root="/path/to/app", dir='static')
- def page(self):
- # ...
-
-
-Page Handlers
--------------
-
-...and in this case, we can do even **better** because tools.staticdir is a
-:class:`HandlerTool <cherrypy._cptools.HandlerTool>`, and therefore can be
-used directly as a page handler::
-
- class docroot(object):
-
- static = tools.staticdir.handler(
- section='static', root="/path/to/app", dir='static')
-
-Direct invocation
------------------
-
-Finally, you can use (most) Tools directly, by calling the function they wrap.
-They expose this via the 'callable' attribute::
-
- def page(self):
- tools.response_headers.callable([('Content-Language', 'fr')])
- return "Bonjour, le Monde!"
- page.exposed = True
-
-help(Tool)
-==========
-
-Because the underlying function is wrapped in a tool, you need to call
-``help(tools.whatevertool.callable)`` if you want the docstring for it.
-Using ``help(tools.whatevertool)`` will give you help on how to use it
-as a Tool (for example, as a decorator).
-
-Tools also are also **inspectable** automatically. They expose their own
-arguments as attributes::
-
- >>> dir(cherrypy.tools.session_auth)
- [..., 'anonymous', 'callable', 'check_username_and_password',
- 'do_check', 'do_login', 'do_logout', 'handler', 'login_screen',
- 'on_check', 'on_login', 'on_logout', 'run', 'session_key']
-
-This makes IDE calltips especially useful, even when writing config files!
-