diff options
47 files changed, 784 insertions, 106 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..ec13d7f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# +# Paste documentation build configuration file, created by +# sphinx-quickstart on Tue Apr 22 22:08:49 2008. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# The contents of this file are pickled, so don't put values in the namespace +# that aren't pickleable (module imports are okay, they're removed automatically). +# +# All configuration values have a default value; values that are commented out +# serve to show the default value. + +import sys + +# If your extensions are in another directory, add it here. +#sys.path.append('some/directory') + +# General configuration +# --------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.txt' + +# The master toctree document. +master_doc = 'index' + +# General substitutions. +project = 'Paste' +copyright = '2008, Ian Bicking' + +# The default replacements for |version| and |release|, also used in various +# other places throughout the built documents. +# +# The short X.Y version. +version = '1.6' +# The full version, including alpha/beta/rc tags. +release = '1.6.1' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +today_fmt = '%B %d, %Y' + +# List of documents that shouldn't be included in the build. +unused_docs = ['include/contact.txt', 'include/reference_header.txt'] + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# Options for HTML output +# ----------------------- + +# The style sheet to use for HTML and HTML Help pages. A file of that name +# must exist either in Sphinx' static/ path, or in one of the custom paths +# given in html_static_path. +html_style = 'default.css' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Content template for the index page. +#html_index = '' + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_use_modindex = True + +# If true, the reST sources are included in the HTML build as _sources/<name>. +#html_copy_source = True + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Pastedoc' + + +# Options for LaTeX output +# ------------------------ + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, document class [howto/manual]). +#latex_documents = [] + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True diff --git a/docs/index.txt b/docs/index.txt index e000c56..b810529 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -1,5 +1,34 @@ Python Paste -++++++++++++ +============ + +Contents: + +.. toctree:: + :maxdepth: 1 + + news + testing-applications + url-parsing-with-wsgi + do-it-yourself-framework + paste-httpserver-threadpool + developer-features + DeveloperGuidelines + StyleGuide + paste-httpserver-threadpool + testing-applications + url-parsing-with-wsgi + community/index.txt + community/mailing-list.txt + community/repository.txt + download/index.txt + license + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` .. comment: @@ -21,97 +50,17 @@ Python Paste DSL? DSF! Paste: Comfort for the framework-scarred -Python Paste brings consistency to Python web development and web -application installation, providing tools for both developers and -system administrators. - -Status ------- - -Paste has passed version 1.0. Paste is an actively maintained -project. As of 1.0 (and actually before) we'll make a strong effort -to maintain backward compatibility. This will include deprecation -warnings when necessary. Major changes will take place under new -functions or with new entry points. - -Using Paste does not exclude the use of other WSGI libraries and -components. There's really no advantage to putting new development or -major rewrites in Paste, as opposed to putting them in new packages. -Because of this it is planned that major new development will happen -outside of Paste. This makes Paste a very stable and conservative -piece of infrastructure for building on. This is the intention. - -For up-to-the-minute status see the `news file <news.html>`_. - -Paste for Administrators ------------------------- - -* Easily install, run, and configure multiple Paste-enabled web - applications at once, and integrate them into your website how you - want (SCGI, FCGI, AJP, WSGI) - -* Manage and install web applications system-wide for easy maintenance - -.. comment: - - * `See an installation example <install-example.html>`_ or `read more - about what Paste-enabled means... <enabled.html>`_ - -Paste for Web Developers ------------------------- - -* Increase your web application's audience - -* Provide starter templates and custom commands for using your web - framework - -* Keep your development and deployment straightened out, and your - automated testing streamlined - -* Attention paid to the full development cycle -- starting projects, - converting old projects, updating and deploying projects -- using a - set of `complementary packages and tools <related-projects.html>`_ - -* `read more about some of the available features - <developer-features.html>`_ - -.. comment: - - * `See a development example <develop-example.html>`_ or `read more - about using Paste in your - applications... <developer-features.html>`_ - -Documentation -============= - -* `Testing applications with Paste <testing-applications.html>`_ -* `URL parsing with WSGI <url-parsing-with-wsgi.html>`_ -* `A Do-It-Yourself Framework <do-it-yourself-framework.html>`_ -* `Paste HTTP Server Thread Pool <paste-httpserver-threadpool.html>`_ -* `Contributing developer guidelines <DeveloperGuidelines.html>`_ -* `Style guide <StyleGuide.html>`_ - -Components -========== +Other Components +================ * `Paste Deploy <./deploy/>`_ * `Paste Script <./script/>`_ -* `Paste Module Index <module-index.html>`_ - -* `Paste WebKit <./webkit/>`_ - -* `Wareweb <./wareweb/>`_ +* `WebOb <./webob/>`_ * `WSGI specification <http://www.python.org/peps/pep-0333.html>`_ -* `Example application: to-do - <http://svn.pythonpaste.org/Paste/apps/Todo_SQLObject_ZPT/trunk/>`_. - -* `Example application: FileBrowser - <http://svn.pythonpaste.org/Paste/apps/FileBrowser/trunk/>`_ - License ======= diff --git a/docs/modules/auth.auth_tkt.txt b/docs/modules/auth.auth_tkt.txt new file mode 100644 index 0000000..8622bcf --- /dev/null +++ b/docs/modules/auth.auth_tkt.txt @@ -0,0 +1,14 @@ +:mod:`paste.auth.auth_tkt` -- auth_tkt cookie parsing +===================================================== + +.. automodule:: paste.auth.auth_tkt + +Module Contents +--------------- + +.. autoclass:: AuthTKTMiddleware +.. autofunction:: make_auth_tkt_middleware +.. autoclass:: AuthTicket +.. autoexception:: BadTicket + + diff --git a/docs/modules/auth.basic.txt b/docs/modules/auth.basic.txt new file mode 100644 index 0000000..2f8f21f --- /dev/null +++ b/docs/modules/auth.basic.txt @@ -0,0 +1,11 @@ +:mod:`paste.auth.basic` -- Basic HTTP authentication +==================================================== + +.. automodule:: paste.auth.basic + +Module Contents +--------------- + +.. autoclass:: AuthBasicAuthenticator +.. autoclass:: AuthBasicHandler +.. autofunction:: make_basic diff --git a/docs/modules/auth.cas.txt b/docs/modules/auth.cas.txt new file mode 100644 index 0000000..d32dd7a --- /dev/null +++ b/docs/modules/auth.cas.txt @@ -0,0 +1,11 @@ +:mod:`paste.auth.cas` -- CAS authentication +=========================================== + +.. automodule:: paste.auth.cas + +Module Contents +--------------- + +.. autoclass:: AuthCASHandler + + diff --git a/docs/modules/auth.cookie.txt b/docs/modules/auth.cookie.txt new file mode 100644 index 0000000..000cb52 --- /dev/null +++ b/docs/modules/auth.cookie.txt @@ -0,0 +1,12 @@ +:mod:`paste.auth.cookie` -- Cookie-based authentication +======================================================= + +.. automodule:: paste.auth.cookie + +Module Contents +--------------- + +.. autoclass:: AuthCookieSigner +.. autoclass:: AuthCookieHandler +.. autoclass:: AuthCookieEnviron +.. autofunction:: make_auth_cookie diff --git a/docs/modules/auth.digest.txt b/docs/modules/auth.digest.txt new file mode 100644 index 0000000..d13357e --- /dev/null +++ b/docs/modules/auth.digest.txt @@ -0,0 +1,12 @@ +:mod:`paste.auth.digest` -- HTTP Digest login +============================================= + +.. automodule:: paste.auth.digest + +Module Contents +--------------- + +.. autoclass:: AuthDigestAuthenticator +.. autoclass:: AuthDigestHandler +.. autofunction:: digest_password +.. autofunction:: make_digest diff --git a/docs/modules/auth.form.txt b/docs/modules/auth.form.txt new file mode 100644 index 0000000..c059589 --- /dev/null +++ b/docs/modules/auth.form.txt @@ -0,0 +1,10 @@ +:mod:`paste.auth.form` -- HTML form/cookie authentication +========================================================= + +.. automodule:: paste.auth.form + +Module Contents +--------------- + +.. autoclass:: AuthFormHandler +.. autofunction:: make_form diff --git a/docs/modules/auth.grantip.txt b/docs/modules/auth.grantip.txt new file mode 100644 index 0000000..ead45d7 --- /dev/null +++ b/docs/modules/auth.grantip.txt @@ -0,0 +1,10 @@ +:mod:`paste.auth.grantip` -- Set user and groups based on IP address +==================================================================== + +.. automodule:: paste.auth.grantip + +Module Contents +--------------- + +.. autoclass:: GrantIPMiddleware +.. autofunction:: make_grantip diff --git a/docs/modules/auth.multi.txt b/docs/modules/auth.multi.txt new file mode 100644 index 0000000..5813ee7 --- /dev/null +++ b/docs/modules/auth.multi.txt @@ -0,0 +1,11 @@ +:mod:`paste.auth.multi` -- Authentication via one of multiple methods +===================================================================== + +.. automodule:: paste.auth.multi + +Module Contents +--------------- + +.. autoclass:: MultiHandler + + diff --git a/docs/modules/auth.open_id.txt b/docs/modules/auth.open_id.txt new file mode 100644 index 0000000..d60af3e --- /dev/null +++ b/docs/modules/auth.open_id.txt @@ -0,0 +1,12 @@ +:mod:`paste.auth.open_id` -- OpenID authentication +================================================== + +.. automodule:: paste.auth.open_id + +Module Contents +--------------- + +.. comment: + + .. autoclass:: AuthOpenIDHandler + .. autofunction:: make_open_id_middleware diff --git a/docs/modules/cascade.txt b/docs/modules/cascade.txt new file mode 100644 index 0000000..b54c735 --- /dev/null +++ b/docs/modules/cascade.txt @@ -0,0 +1,10 @@ +:mod:`paste.cascade` -- send requests to multiple applications until success +============================================================================ + +.. automodule:: paste.cascade + +Module Contents +--------------- + +.. autoclass:: Cascade +.. autofunction:: make_cascade diff --git a/docs/modules/cgiapp.txt b/docs/modules/cgiapp.txt new file mode 100644 index 0000000..039ec6d --- /dev/null +++ b/docs/modules/cgiapp.txt @@ -0,0 +1,11 @@ +:mod:`paste.cgiapp` -- run CGI scripts as WSGI applications +=========================================================== + +.. automodule:: paste.cgiapp + +Module Contents +--------------- + +.. autoclass:: CGIApplication +.. autoexception:: CGIError +.. autofunction:: make_cgi_application diff --git a/docs/modules/cgitb_catcher.txt b/docs/modules/cgitb_catcher.txt new file mode 100644 index 0000000..44f8771 --- /dev/null +++ b/docs/modules/cgitb_catcher.txt @@ -0,0 +1,10 @@ +:mod:`paste.cgitb_catcher` -- catch exceptions using cgitb +========================================================== + +.. automodule:: paste.cgitb_catcher + +Module Contents +--------------- + +.. autoclass:: CgitbMiddleware +.. autofunction:: make_cgitb_middleware diff --git a/docs/modules/debug.debugapp.txt b/docs/modules/debug.debugapp.txt new file mode 100644 index 0000000..1eb0a54 --- /dev/null +++ b/docs/modules/debug.debugapp.txt @@ -0,0 +1,13 @@ +:mod:`paste.debug.debugapp` -- debug app +======================================== + +.. automodule:: paste.debug.debugapp + +Module Contents +--------------- + +.. autoclass:: SimpleApplication +.. autoclass:: SlowConsumer +.. autofunction:: make_test_app +.. autofunction:: make_slow_app + diff --git a/docs/modules/debug.prints.txt b/docs/modules/debug.prints.txt new file mode 100644 index 0000000..1787e71 --- /dev/null +++ b/docs/modules/debug.prints.txt @@ -0,0 +1,10 @@ +:mod:`paste.debug.prints` -- capture print output +================================================= + +.. automodule:: paste.debug.prints + +Module Contents +--------------- + +.. autoclass:: PrintDebugMiddleware + diff --git a/docs/modules/debug.profile.txt b/docs/modules/debug.profile.txt new file mode 100644 index 0000000..ccc0910 --- /dev/null +++ b/docs/modules/debug.profile.txt @@ -0,0 +1,13 @@ +:mod:`paste.debug.profile` -- profile applications and requests +=============================================================== + +.. automodule:: paste.debug.profile + +Module Contents +--------------- + +.. autoclass:: ProfileMiddleware +.. autofunction:: make_profile_middleware +.. autofunction:: profile_decorator + + diff --git a/docs/modules/debug.watchthreads.txt b/docs/modules/debug.watchthreads.txt new file mode 100644 index 0000000..cd0c915 --- /dev/null +++ b/docs/modules/debug.watchthreads.txt @@ -0,0 +1,12 @@ +:mod:`paste.debug.watchthreads` -- watch thread workers in paste.httpserver +=========================================================================== + +.. automodule:: paste.debug.watchthreads + +Module Contents +--------------- + +.. autoclass:: WatchThreads +.. autofunction:: make_watch_threads +.. autofunction:: make_bad_app + diff --git a/docs/modules/debug.wdg_validate.txt b/docs/modules/debug.wdg_validate.txt new file mode 100644 index 0000000..26f7eff --- /dev/null +++ b/docs/modules/debug.wdg_validate.txt @@ -0,0 +1,11 @@ +:mod:`paste.debug.debugapp` -- debug app +======================================== + +.. automodule:: paste.debug.wdg_validate + +Module Contents +--------------- + +.. autoclass:: WDGValidateMiddleware +.. autofunction:: make_wdg_validate_middleware + diff --git a/docs/modules/errordocument.txt b/docs/modules/errordocument.txt new file mode 100644 index 0000000..111ac18 --- /dev/null +++ b/docs/modules/errordocument.txt @@ -0,0 +1,12 @@ +:mod:`paste.errordocument` -- Do internal redirects for error responses +======================================================================= + +.. automodule:: paste.errordocument + +Module Contents +--------------- + +.. autoclass:: StatusBasedForward +.. autofunction:: make_errordocument + + diff --git a/docs/modules/evalexception.txt b/docs/modules/evalexception.txt new file mode 100644 index 0000000..23587fe --- /dev/null +++ b/docs/modules/evalexception.txt @@ -0,0 +1,9 @@ +:mod:`paste.evalexception` -- Interactive debugging for errors +============================================================== + +.. automodule:: paste.evalexception + +Module Contents +--------------- + +.. autoclass:: EvalException diff --git a/docs/modules/exceptions.txt b/docs/modules/exceptions.txt new file mode 100644 index 0000000..dd1a63f --- /dev/null +++ b/docs/modules/exceptions.txt @@ -0,0 +1,48 @@ +:mod:`paste.exceptions` -- Catch, display, and notify for exceptions +==================================================================== + +.. automodule:: paste.exceptions.errormiddleware + +Module Contents +--------------- + +.. autoclass:: ErrorMiddleware +.. autofunction:: handle_exception +.. autofunction:: make_error_middleware + +:mod:`paste.exceptions.collector` -- Collection information from exceptions +=========================================================================== + +.. automodule:: paste.exceptions.collector + +Module Contents +--------------- + +.. autoclass:: ExceptionCollector +.. autofunction:: collect_exception + +:mod:`paste.exceptions.formatter` -- Format exception information +================================================================= + +.. automodule:: paste.exceptions.formatter + +Module Contents +--------------- + +.. autoclass:: TextFormatter +.. autoclass:: HTMLFormatter +.. autofunction:: format_html +.. autofunction:: format_text + +:mod:`paste.exceptions.reporter` -- Report exceptions +===================================================== + +.. automodule:: paste.exceptions.reporter + +Module Contents +--------------- + +.. autoclass:: EmailReporter +.. autoclass:: LogReporter +.. autoclass:: FileReporter +.. autoclass:: WSGIAppReporter diff --git a/docs/modules/fileapp.txt b/docs/modules/fileapp.txt new file mode 100644 index 0000000..b8d7599 --- /dev/null +++ b/docs/modules/fileapp.txt @@ -0,0 +1,14 @@ +:mod:`paste.fileapp` -- Serve files +=================================== + +.. automodule:: paste.fileapp + +Module Contents +--------------- + +.. autoclass:: FileApp +.. autofunction:: DataApp +.. autofunction:: ArchiveStore + + + diff --git a/docs/modules/fixture.txt b/docs/modules/fixture.txt new file mode 100644 index 0000000..c519ce2 --- /dev/null +++ b/docs/modules/fixture.txt @@ -0,0 +1,40 @@ +:mod:`paste.fixture` -- Test applications +========================================= + +.. contents:: + +.. automodule:: paste.fixture + +Module Contents +--------------- + +.. autoclass:: TestApp + :members: +.. autoclass:: TestRequest + +Forms +----- + +.. autoclass:: Form + :members: +.. autoclass:: Field + :members: +.. autoclass:: Select +.. autoclass:: Radio +.. autoclass:: Checkbox +.. autoclass:: Text +.. autoclass:: Textarea +.. autoclass:: Hidden +.. autoclass:: Submit + +Script Testing +-------------- + +.. autoclass:: TestFileEnvironment + :members: +.. autoclass:: ProcResult + :members: +.. autoclass:: FoundFile +.. autoclass:: FoundDir + + diff --git a/docs/modules/gzipper.txt b/docs/modules/gzipper.txt new file mode 100644 index 0000000..1036422 --- /dev/null +++ b/docs/modules/gzipper.txt @@ -0,0 +1,10 @@ +:mod:`paste.gzipper` -- Gzip-compress responses +=============================================== + +.. automodule:: paste.gzipper + +Module Contents +--------------- + +.. autoclass:: middleware +.. autofunction:: make_gzip_middleware diff --git a/docs/modules/httpexceptions.txt b/docs/modules/httpexceptions.txt new file mode 100644 index 0000000..736576b --- /dev/null +++ b/docs/modules/httpexceptions.txt @@ -0,0 +1,49 @@ +:mod:`paste.httpexceptions` -- Easily product HTTP errors +========================================================= + +.. automodule:: paste.httpexceptions + +Module Contents +--------------- + +.. autoclass:: HTTPExceptionHandler +.. autofunction:: make_middleware + +Exceptions +---------- + +.. autoexception:: HTTPException +.. autoexception:: HTTPError +.. autoexception:: HTTPRedirection +.. autoexception:: HTTPMultipleChoices +.. autoexception:: HTTPMovedPermanently +.. autoexception:: HTTPFound +.. autoexception:: HTTPNotModified +.. autoexception:: HTTPUseProxy +.. autoexception:: HTTPTemporaryRedirect +.. autoexception:: HTTPClientError +.. autoexception:: HTTPBadRequest +.. autoexception:: HTTPUnauthorized +.. autoexception:: HTTPPaymentRequired +.. autoexception:: HTTPForbidden +.. autoexception:: HTTPNotFound +.. autoexception:: HTTPMethodNotAllowed +.. autoexception:: HTTPNotAcceptable +.. autoexception:: HTTPProxyAuthenticationRequired +.. autoexception:: HTTPRequestTimeout +.. autoexception:: HTTPConflict +.. autoexception:: HTTPGone +.. autoexception:: HTTPLengthRequired +.. autoexception:: HTTPPreconditionFailed +.. autoexception:: HTTPRequestEntityTooLarge +.. autoexception:: HTTPRequestURITooLong +.. autoexception:: HTTPUnsupportedMediaType +.. autoexception:: HTTPRequestRangeNotSatisfiable +.. autoexception:: HTTPExpectationFailed +.. autoexception:: HTTPServerError +.. autoexception:: HTTPInternalServerError +.. autoexception:: HTTPNotImplemented +.. autoexception:: HTTPBadGateway +.. autoexception:: HTTPServiceUnavailable +.. autoexception:: HTTPGatewayTimeout +.. autoexception:: HTTPVersionNotSupported diff --git a/docs/modules/httpheaders.txt b/docs/modules/httpheaders.txt new file mode 100644 index 0000000..ef5c74b --- /dev/null +++ b/docs/modules/httpheaders.txt @@ -0,0 +1,8 @@ +:mod:`paste.httpheaders` -- Manipulate HTTP Headers +=================================================== + +.. comment: + I just don't feel like documenting the items... + +.. automodule:: paste.httpheaders + :members: diff --git a/docs/modules/httpserver.txt b/docs/modules/httpserver.txt new file mode 100644 index 0000000..5d260c5 --- /dev/null +++ b/docs/modules/httpserver.txt @@ -0,0 +1,10 @@ +:mod:`paste.httpserver` -- HTTP server +====================================== + +.. automodule:: paste.httpserver + +Module Contents +--------------- + +.. autofunction:: serve +.. autofunction:: server_runner diff --git a/docs/modules/lint.txt b/docs/modules/lint.txt new file mode 100644 index 0000000..7a21caf --- /dev/null +++ b/docs/modules/lint.txt @@ -0,0 +1,10 @@ +:mod:`paste.lint` -- Check for the validity of WSGI requests and responses +========================================================================== + +.. automodule:: paste.lint + +Module Contents +--------------- + +.. autofunction:: middleware +.. autoexception:: WSGIWarning diff --git a/docs/modules/pony.txt b/docs/modules/pony.txt new file mode 100644 index 0000000..b2c281b --- /dev/null +++ b/docs/modules/pony.txt @@ -0,0 +1,10 @@ +:mod:`paste.pony` -- Add pony power to your application +======================================================= + +.. automodule:: paste.pony + +Module Contents +--------------- + +.. autoclass:: PonyMiddleware +.. autofunction:: make_pony diff --git a/docs/modules/progress.txt b/docs/modules/progress.txt new file mode 100644 index 0000000..8b15dc8 --- /dev/null +++ b/docs/modules/progress.txt @@ -0,0 +1,13 @@ +:mod:`paste.progress` -- Track progress of uploads +================================================== + +.. automodule:: paste.progress + +Module Contents +--------------- + +.. autoclass:: UploadProgressMonitor +.. autoclass:: UploadProgressReporter + + + diff --git a/docs/modules/proxy.txt b/docs/modules/proxy.txt new file mode 100644 index 0000000..1e6841d --- /dev/null +++ b/docs/modules/proxy.txt @@ -0,0 +1,14 @@ +:mod:`paste.proxy` -- Proxy WSGI requests to HTTP requests +========================================================== + +.. automodule:: paste.proxy + +Module Contents +--------------- + +.. autoclass:: Proxy +.. autofunction:: make_proxy +.. autoclass:: TransparentProxy +.. autofunction:: make_transparent_proxy + + diff --git a/docs/modules/recursive.txt b/docs/modules/recursive.txt new file mode 100644 index 0000000..a9339de --- /dev/null +++ b/docs/modules/recursive.txt @@ -0,0 +1,10 @@ +:mod:`paste.recursive` -- internal requests +=========================================== + +.. automodule:: paste.recursive + +Module Contents +--------------- + +.. autoclass:: RecursiveMiddleware +.. autofunction:: ForwardRequestException diff --git a/docs/modules/registry.txt b/docs/modules/registry.txt new file mode 100644 index 0000000..aba5bce --- /dev/null +++ b/docs/modules/registry.txt @@ -0,0 +1,13 @@ +:mod:`paste.registry` -- Manage thread-local request-specific objects +===================================================================== + +.. automodule:: paste.registry + +Module Contents +--------------- + +.. autoclass:: StackedObjectProxy +.. autoclass:: Registry +.. autoclass:: RegistryManager +.. autoclass:: StackedObjectRestorer +.. autofunction:: make_registry_manager diff --git a/docs/modules/reloader.txt b/docs/modules/reloader.txt new file mode 100644 index 0000000..fb27333 --- /dev/null +++ b/docs/modules/reloader.txt @@ -0,0 +1,14 @@ +:mod:`paste.reloader` -- Monitor for file changes to restart the process +======================================================================== + +.. automodule:: paste.reloader + +Module Contents +--------------- + +.. autofunction:: install +.. autoclass:: Monitor +.. autofunction:: watch_file + + + diff --git a/docs/modules/request.txt b/docs/modules/request.txt new file mode 100644 index 0000000..d37b129 --- /dev/null +++ b/docs/modules/request.txt @@ -0,0 +1,19 @@ +:mod:`paste.request` -- Utility functions for the WSGI environment +================================================================== + +.. automodule:: paste.request + +Module Contents +--------------- + +.. autofunction:: get_cookies +.. autofunction:: get_cookie_dict +.. autofunction:: parse_querystring +.. autofunction:: parse_formvars +.. autofunction:: construct_url +.. autofunction:: path_info_split +.. autofunction:: path_info_pop +.. autofunction:: resolve_relative_url +.. autoclass:: EnvironHeaders + + diff --git a/docs/modules/response.txt b/docs/modules/response.txt new file mode 100644 index 0000000..1b6c129 --- /dev/null +++ b/docs/modules/response.txt @@ -0,0 +1,15 @@ +:mod:`paste.response` -- Utility functions for producing responses +================================================================== + +.. automodule:: paste.response + +Module Contents +--------------- + +.. autoclass:: HeaderDict +.. autofunction:: has_header +.. autofunction:: header_value +.. autofunction:: remove_header +.. autofunction:: replace_header + + diff --git a/docs/modules/session.txt b/docs/modules/session.txt new file mode 100644 index 0000000..6a11dfd --- /dev/null +++ b/docs/modules/session.txt @@ -0,0 +1,11 @@ +:mod:`paste.session` -- Simple file-based sessions +================================================== + +.. automodule:: paste.session + +Module Contents +--------------- + +.. autoclass:: SessionMiddleware +.. autofunction:: make_session_middleware + diff --git a/docs/modules/transaction.txt b/docs/modules/transaction.txt new file mode 100644 index 0000000..1e23a3e --- /dev/null +++ b/docs/modules/transaction.txt @@ -0,0 +1,11 @@ +:mod:`paste.transaction` -- DB-API transactions +=============================================== + +.. automodule:: paste.transaction + +Module Contents +--------------- + +.. autoclass:: TransactionManagerMiddleware +.. autoclass:: ConnectionFactory +.. autofunction:: BasicTransactionHandler diff --git a/docs/modules/translogger.txt b/docs/modules/translogger.txt new file mode 100644 index 0000000..84a7217 --- /dev/null +++ b/docs/modules/translogger.txt @@ -0,0 +1,10 @@ +:mod:`paste.translogger` -- Log requests +======================================== + +.. automodule:: paste.translogger + +Module Contents +--------------- + +.. autoclass:: TransLogger +.. autofunction:: make_filter diff --git a/docs/modules/url.txt b/docs/modules/url.txt new file mode 100644 index 0000000..6b5e83f --- /dev/null +++ b/docs/modules/url.txt @@ -0,0 +1,10 @@ +:mod:`paste.url` -- URL convenience class +========================================= + +.. automodule:: paste.url + +Module Contents +--------------- + +.. autoclass:: URL +.. autoclass:: Image diff --git a/docs/modules/urlmap.txt b/docs/modules/urlmap.txt new file mode 100644 index 0000000..ae584d9 --- /dev/null +++ b/docs/modules/urlmap.txt @@ -0,0 +1,11 @@ +:mod:`paste.urlmap` -- Map URL paths +==================================== + +.. automodule:: paste.urlmap + +Module Contents +--------------- + +.. autoclass:: URLMap +.. autofunction:: urlmap_factory +.. autoclass:: PathProxyURLMap diff --git a/docs/modules/urlparser.txt b/docs/modules/urlparser.txt new file mode 100644 index 0000000..28752ab --- /dev/null +++ b/docs/modules/urlparser.txt @@ -0,0 +1,14 @@ +:mod:`paste.urlparser` -- Handle URL paths and server static files +================================================================== + +.. automodule:: paste.urlparser + +Module Contents +--------------- + +.. autoclass:: StaticURLParser +.. autofunction:: make_static +.. autoclass:: PkgResourcesParser +.. autofunction:: make_pkg_resources +.. autoclass:: URLParser +.. autofunction:: make_url_parser diff --git a/docs/modules/util.import_string.txt b/docs/modules/util.import_string.txt new file mode 100644 index 0000000..04586d1 --- /dev/null +++ b/docs/modules/util.import_string.txt @@ -0,0 +1,12 @@ +:mod:`paste.util.import_string` -- Import objects from strings +============================================================== + +.. automodule:: paste.util.import_string + +Module Contents +--------------- + +.. autofunction:: eval_import +.. autofunction:: simple_import +.. autofunction:: import_module +.. autofunction:: try_import_module diff --git a/docs/modules/wsgilib.txt b/docs/modules/wsgilib.txt new file mode 100644 index 0000000..5c443c7 --- /dev/null +++ b/docs/modules/wsgilib.txt @@ -0,0 +1,19 @@ +:mod:`paste.wsgilib` -- Miscellaneous WSGI utility functions +============================================================ + +.. automodule:: paste.wsgilib + +Module Contents +--------------- + +.. autofunction:: add_close +.. autofunction:: add_start_close +.. autofunction:: chained_app_iters +.. autoclass:: encode_unicode_app_iter +.. autofunction:: catch_errors +.. autofunction:: catch_errors_app +.. autofunction:: raw_interactive +.. autofunction:: interactive +.. autofunction:: dump_environ +.. autofunction:: capture_stdout +.. autofunction:: intercept_output diff --git a/docs/modules/wsgiwrappers.txt b/docs/modules/wsgiwrappers.txt new file mode 100644 index 0000000..7774854 --- /dev/null +++ b/docs/modules/wsgiwrappers.txt @@ -0,0 +1,10 @@ +:mod:`paste.wsgiwrappers` -- Wrapper functions for WSGI request and response +============================================================================ + +.. automodule:: paste.wsgiwrappers + +Module Contents +--------------- + +.. autoclass:: WSGIRequest +.. autoclass:: WSGIResponse diff --git a/docs/web/index.txt b/docs/web/index.txt deleted file mode 100644 index ac05668..0000000 --- a/docs/web/index.txt +++ /dev/null @@ -1,22 +0,0 @@ -Python Paste -++++++++++++ - -Introduction -============ - -Python Paste is a web application framework framework. It uses WSGI_ -to create a framework-neutral set of components. It also assists with -application setup and deployment. - -Paste includes a reimplementation of `Webware for Python`_. - -.. _Webware for python: http://www.webwareforpython.org -.. _WSGI: http://www.python.org/peps/pep-0333.html - -To check out Paste:: - - $ svn co http://svn.w4py.org/Paste/trunk Paste - -Note that it includes a script ``build-pkg`` which fetches a bunch of -packages that make Paste more useful. A big tarball of all the -requirements stuffed together will probably be forthcoming. |