diff options
| -rw-r--r-- | docs/developer-features.txt | 98 | ||||
| -rw-r--r-- | docs/modules/debug.fsdiff.txt | 15 |
2 files changed, 64 insertions, 49 deletions
diff --git a/docs/developer-features.txt b/docs/developer-features.txt index 37dbf5f..503d419 100644 --- a/docs/developer-features.txt +++ b/docs/developer-features.txt @@ -1,148 +1,148 @@ -Documentation -============= +Features +======== Testing ------- * A fixture for testing WSGI applications conveniently and in-process, - in ``paste.fixture`` + in :class:`paste.fixture.TestApp` * A fixture for testing command-line applications, also in - ``paste.fixture`` + :class:`paste.fixture.TestFileEnvironment` -* Check components for WSGI-compliance in ``paste.lint`` +* Check components for WSGI-compliance in :mod:`paste.lint` -* Check filesystem changes, with ``paste.debug.fsdiff`` +* Check filesystem changes, with :mod:`paste.debug.fsdiff` Server ------ -* A threaded HTTP server in ``paste.httpserver`` +* A threaded HTTP server in :mod:`paste.httpserver` * A tool for seeing and killing errant threads in the HTTP server, in - ``paste.debug.watchthreads`` + :mod:`paste.debug.watchthreads` Dispatching ----------- * Chain and cascade WSGI applications (returning the first non-error - response) in ``paste.cascade`` + response) in :mod:`paste.cascade` * Dispatch to several WSGI applications based on URL prefixes, in - ``paste.urlmap`` + :mod:`paste.urlmap` * Allow applications to make subrequests and forward requests - internally, in ``paste.recursive`` + internally, in :mod:`paste.recursive` * Redirect error pages (e.g., 404 Not Found) to custom error pages, in - ``paste.errordocument``. + :mod:`paste.errordocument`. Web Application --------------- * Easily deal with incoming requests and sending a response in - ``paste.wsgiwrappers`` + :mod:`paste.wsgiwrappers` -* Work directly with the WSGI environment in ``paste.request`` +* Work directly with the WSGI environment in :mod:`paste.request` -* Run CGI programs as WSGI applications in ``paste.cgiapp`` +* Run CGI programs as WSGI applications in :mod:`paste.cgiapp` * Traverse files and load WSGI applications from ``.py`` files (or - static files), in ``paste.urlparser`` + static files), in :mod:`paste.urlparser` -* Serve static directories of files, also in ``paste.urlparser``; also +* Serve static directories of files, also in :mod:`paste.urlparser`; also serve using the Setuptools ``pkg_resources`` resource API. * Proxy to other servers, treating external HTTP servers as WSGI - applications, in ``paste.proxy``. + applications, in :mod:`paste.proxy`. * Serve files (with support for ``If-Modified-Since``, etc) in - ``paste.fileapp`` + :mod:`paste.fileapp` Tools ----- * Catch HTTP-related exceptions (e.g., ``HTTPNotFound``) and turn them - into proper responses in ``paste.httpexceptions`` + into proper responses in :mod:`paste.httpexceptions` -* Manage HTTP header fields with ``paste.httpheaders`` +* Manage HTTP header fields with :mod:`paste.httpheaders` -* Handle authentication/identification of requests in ``paste.auth`` +* Handle authentication/identification of requests in :mod:`paste.auth` -* Create sessions in ``paste.session`` and ``paste.flup_session`` +* Create sessions in :mod:`paste.session` and :mod:`paste.flup_session` -* Gzip responses in ``paste.gzipper`` +* Gzip responses in :mod:`paste.gzipper` * A wide variety of routines for manipulating WSGI requests and - producing responses, in ``paste.request``, ``paste.response`` and - ``paste.wsgilib``. + producing responses, in :mod:`paste.request`, :mod:`paste.response` and + :mod:`paste.wsgilib`. -* Create Apache-style logs in ``paste.translogger`` +* Create Apache-style logs in :mod:`paste.translogger` -* Handy request and response wrappers in ``paste.wsgiwrappers`` +* Handy request and response wrappers in :mod:`paste.wsgiwrappers` -* Handling of request-local module globals sanely in ``paste.registry`` +* Handling of request-local module globals sanely in :mod:`paste.registry` Authentication -------------- -* Authentication using cookies in ``paste.auth.cookie`` and - ``paste.auth.auth_tkt``; login form in ``paste.auth.form`` +* Authentication using cookies in :mod:`paste.auth.cookie` and + :mod:`paste.auth.auth_tkt`; login form in :mod:`paste.auth.form` * Authentication using `OpenID <http://openid.net/>`_ in - ``paste.auth.open_id``, using `CAS - <http://www.ja-sig.org/products/cas/>`_ in ``paste.auth.cas`` + :mod:`paste.auth.open_id`, using `CAS + <http://www.ja-sig.org/products/cas/>`_ in :mod:`paste.auth.cas` -* HTTP authentication in ``paste.auth.basic`` and - ``paste.auth.digest`` +* HTTP authentication in :mod:`paste.auth.basic` and + :mod:`paste.auth.digest` * Dispatch to different authentication methods based on User-Agent, in - ``paste.auth.multi`` + :mod:`paste.auth.multi` -* Grant roles based on IP addresses, in ``paste.auth.grantip`` +* Grant roles based on IP addresses, in :mod:`paste.auth.grantip` Debugging Filters ----------------- * Catch (optionally email) errors with extended tracebacks (using - Zope/ZPT conventions) in ``paste.exceptions`` + Zope/ZPT conventions) in :mod:`paste.exceptions` * During debugging, show tracebacks with information about each stack frame, including an interactive prompt that runs in the individual - stack frames, in ``paste.evalexception``. + stack frames, in :mod:`paste.evalexception`. * Catch errors presenting a `cgitb <http://python.org/doc/current/lib/module-cgitb.html>`_-based - output, in ``paste.cgitb_catcher``. + output, in :mod:`paste.cgitb_catcher`. * Profile each request and append profiling information to the HTML, - in ``paste.debug.profile`` + in :mod:`paste.debug.profile` * Capture ``print`` output and present it in the browser for - debugging, in ``paste.debug.prints`` + debugging, in :mod:`paste.debug.prints` * Validate all HTML output from applications using the `WDG Validator <http://www.htmlhelp.com/tools/validator/>`_, appending any errors - or warnings to the page, in ``paste.debug.wdg_validator`` + or warnings to the page, in :mod:`paste.debug.wdg_validator` Other Tools ----------- * A file monitor to allow restarting the server when files have been updated (for automatic restarting when editing code) in - ``paste.reloader`` + :mod:`paste.reloader` * A class for generating and traversing URLs, and creating associated - HTML code, in ``paste.url`` + HTML code, in :mod:`paste.url` * A small templating language (for internal use) in - ``paste.util.template`` + :mod:`paste.util.template` -* A class to help with loops in templates, in ``paste.util.looper`` +* A class to help with loops in templates, in :mod:`paste.util.looper` * Import modules and objects given a string, in - ``paste.util.import_string`` + :mod:`paste.util.import_string` * Ordered dictionary that can have multiple values with the same key, - in ``paste.util.multidict`` + in :mod:`paste.util.multidict` diff --git a/docs/modules/debug.fsdiff.txt b/docs/modules/debug.fsdiff.txt new file mode 100644 index 0000000..0a267e7 --- /dev/null +++ b/docs/modules/debug.fsdiff.txt @@ -0,0 +1,15 @@ +:mod:`paste.debug.fsdiff` -- Show differences between directories +================================================================= + +.. automodule:: paste.debug.fsdiff + +Module Contents +--------------- + +.. autoclass:: Diff +.. autoclass:: Snapshot +.. autoclass:: File +.. autoclass:: Dir +.. autofunction:: report_expected_diffs +.. autofunction:: show_diff + |