# HG changeset patch # User paulb # Date 1126396239 0 # Node ID 6361cbac7b97a31d9b22d8a5028a15f994532486 # Parent 881b64c7d4dd7bf3503bbb0bda0b19cc4b704df3 [project @ 2005-09-10 23:50:39 by paulb] Reindented various sections and reformatted the release notes. diff -r 881b64c7d4dd -r 6361cbac7b97 README.txt --- a/README.txt Fri Sep 09 20:47:25 2005 +0000 +++ b/README.txt Sat Sep 10 23:50:39 2005 +0000 @@ -55,133 +55,138 @@ New in WebStack 1.0 (Changes since WebStack 0.10) ------------------------------------------------- -Changed the behaviour of get_path, get_path_without_query, get_path_info, -get_virtual_path_info, get_processed_virtual_path_info and -get_fields_from_path to return Unicode data decoded using the optional -encoding parameter or a common default encoding. -Fixed file upload values so that FileContent objects are returned for such -fields in get_fields_from_body and get_fields. (Warning! Except for Twisted!) -Fixed the JavaServlet support so that streams and file content are obtained as -"almost" plain strings. -Updated/fixed LoginResource and LoginRedirectResource to use the updated path -API and to handle special characters properly. -Added convenience methods to Transaction for the decoding and encoding of path -values (to and from Unicode objects) - see the decode_path and encode_path -methods. -Added the notion of processed virtual path info - the part of the original -path info not represented in the current virtual path info. -Added "pass through" behaviour to ResourceMap.MapResource (prompted by a patch -from Scott Robinson). -Fixed ResourceMap.MapResource to handle non-existent resources properly (where -the virtual path info is only one component in length). -Added Debian package support. -Added automatic session directory creation for the WebStack sessions -implementation. -Added support for the repeated retrieval of sessions from the same WebStack -session store, avoiding deadlocks. -Fixed the calendar example, making it perform a proper function. -Made the BaseHTTPRequestHandler and Twisted SimpleWithLogin applications -include the Login application, since Konqueror (at least) does not share -cookies across different port numbers on the same host. -Added the SimpleWithLogin and Login applications to the demonstration. -Improved the documentation, adding information on request headers, and -describing file upload and session support limitations. + * Changed the behaviour of get_path, get_path_without_query, get_path_info, + get_virtual_path_info, get_processed_virtual_path_info and + get_fields_from_path to return Unicode data decoded using the optional + encoding parameter or a common default encoding. + * Fixed file upload values so that FileContent objects are returned for such + fields in get_fields_from_body and get_fields. + (Warning! Except for Twisted!) + * Fixed the JavaServlet support so that streams and file content are + obtained as "almost" plain strings. + * Updated/fixed LoginResource and LoginRedirectResource to use the updated + path API and to handle special characters properly. + * Added convenience methods to Transaction for the decoding and encoding of + path values (to and from Unicode objects) - see the decode_path and + encode_path methods. + * Added the notion of processed virtual path info - the part of the original + path info not represented in the current virtual path info. + * Added "pass through" behaviour to ResourceMap.MapResource (prompted by a + patch from Scott Robinson). + * Fixed ResourceMap.MapResource to handle non-existent resources properly + (where the virtual path info is only one component in length). + * Added Debian package support. + * Added automatic session directory creation for the WebStack sessions + implementation. + * Added support for the repeated retrieval of sessions from the same + WebStack session store, avoiding deadlocks. + * Fixed the calendar example, making it perform a proper function. + * Made the BaseHTTPRequestHandler and Twisted SimpleWithLogin applications + include the Login application, since Konqueror (at least) does not share + cookies across different port numbers on the same host. + * Added the SimpleWithLogin and Login applications to the demonstration. + * Improved the documentation, adding information on request headers, and + describing file upload and session support limitations. New in WebStack 0.10 (Changes since WebStack 0.9) ------------------------------------------------- -Changes to make the tools/demo.py script work on Windows (and other) platforms -(suggested by Jim Madsen). -Fixed end of header newlines for CGI (suggested by Matt Harrison). -Minor documentation fixes and improvements, adding information on AOLserver in -the CGI and Webware notes. -Changed the mod_python server name method to use the server object rather than -the connection object. -Added a parameter to the ResourceMap.MapResource class to permit automatic -redirects into resource hierarchies when no trailing "/" was given in the URL; -changed the updated virtual path info so that empty values may be set (the -guarantee that "/" will always appear no longer applies). -Fixed virtual path info retrieval when the value is an empty string. + * Changes to make the tools/demo.py script work on Windows (and other) + platforms (suggested by Jim Madsen). + * Fixed end of header newlines for CGI (suggested by Matt Harrison). + * Minor documentation fixes and improvements, adding information on + AOLserver in the CGI and Webware notes. + * Changed the mod_python server name method to use the server object rather + than the connection object. + * Added a parameter to the ResourceMap.MapResource class to permit automatic + redirects into resource hierarchies when no trailing "/" was given in the + URL; changed the updated virtual path info so that empty values may be set + (the guarantee that "/" will always appear no longer applies). + * Fixed virtual path info retrieval when the value is an empty string. New in WebStack 0.9 (Changes since WebStack 0.8) ------------------------------------------------ -Standardised error handling in the adapters so that tracebacks can be -suppressed and an internal server error condition raised. -Added overriding of path info in transactions. -Added a ResourceMap resource for dispatching to different resources -according to path components. -Standardised deployment for some frameworks (see docs/deploying.html). -Introductory documentation in XHTML format. -Added server name and port methods to the transaction. -Added a simple demonstration application, incorporating many of the examples -and launched under a single script. -Fixed mod_python native sessions. -Fixed Zope request stream access. -WebStack is now licensed under the LGPL - see docs/COPYING.txt for details. + * Standardised error handling in the adapters so that tracebacks can be + suppressed and an internal server error condition raised. + * Added overriding of path info in transactions. + * Added a ResourceMap resource for dispatching to different resources + according to path components. + * Standardised deployment for some frameworks (see docs/deploying.html). + * Introductory documentation in XHTML format. + * Added server name and port methods to the transaction. + * Added a simple demonstration application, incorporating many of the + examples and launched under a single script. + * Fixed mod_python native sessions. + * Fixed Zope request stream access. + * WebStack is now licensed under the LGPL - see docs/COPYING.txt for + details. New in WebStack 0.8 (Changes since WebStack 0.7) ------------------------------------------------ -Added a standard exception, EndOfResponse, which can be used to immediately -stop the processing/production of a response; this is useful when resources -need to issue a redirect without unnecessary content being generated, for -example. -Fixed path information for Zope. -Added WSGI support. -Verified Twisted 1.3.0 support with Python 2.3.3. + * Added a standard exception, EndOfResponse, which can be used to + immediately stop the processing/production of a response; this is useful + when resources need to issue a redirect without unnecessary content being + generated, for example. + * Fixed path information for Zope. + * Added WSGI support. + * Verified Twisted 1.3.0 support with Python 2.3.3. New in WebStack 0.7 (Changes since WebStack 0.6) ------------------------------------------------ -Fixed path information semantics. -Fixed file upload semantics. -Fixed content type handling for Unicode output and for interpreting request -body fields/parameters (although some improvement remains). -Added a method to discover the chosen response stream encoding. -Fixed field/parameter retrieval so that path and body fields are distinct, -regardless of the framework employed. -Added a method to get a combination of path and body fields (suggested by -Jacob Smullyan). -Introduced Zope 2 support. -Improved Jython/Java Servlet API support (although a special PyServlet class -must now be used, and certain libraries must be deployed with applications). -Introduced authentication/authorisation support for Jython/Java Servlet API. -Session support has been added (except for Webware 0.8.1). -Alternative cookie support for mod_python has been added. -Cookie support now supports encoded Unicode sequences for names and values. + * Fixed path information semantics. + * Fixed file upload semantics. + * Fixed content type handling for Unicode output and for interpreting + request body fields/parameters (although some improvement remains). + * Added a method to discover the chosen response stream encoding. + * Fixed field/parameter retrieval so that path and body fields are distinct, + regardless of the framework employed. + * Added a method to get a combination of path and body fields (suggested by + Jacob Smullyan). + * Introduced Zope 2 support. + * Improved Jython/Java Servlet API support (although a special PyServlet + class must now be used, and certain libraries must be deployed with + applications). + * Introduced authentication/authorisation support for Jython/Java Servlet + API. + * Session support has been added (except for Webware 0.8.1). + * Alternative cookie support for mod_python has been added. + * Cookie support now supports encoded Unicode sequences for names and + values. New in WebStack 0.6 (Changes since WebStack 0.5) ------------------------------------------------ -Introduced Jython/Java Servlet API support. -Minor fixes to example applications and to BaseHTTPRequestHandler. + * Introduced Jython/Java Servlet API support. + * Minor fixes to example applications and to BaseHTTPRequestHandler. New in WebStack 0.5 (Changes since WebStack 0.4) ------------------------------------------------ -Changed request body fields/parameters so that they are now represented -using Unicode objects rather than plain strings. -Introduced better support for Unicode in response streams. + * Changed request body fields/parameters so that they are now represented + using Unicode objects rather than plain strings. + * Introduced better support for Unicode in response streams. New in WebStack 0.4 (Changes since WebStack 0.3) ------------------------------------------------ -Added application definition of user identity, permitting alternative -authentication mechanisms. -Improved BaseHTTPRequestHandler and mod_python reliability around fields -from request bodies. -Provided stream and environment parameterisation in the CGI adapter. -Added LoginRedirect and Login examples. -Added get_path_without_query and fixed get_path behaviour. + * Added application definition of user identity, permitting alternative + authentication mechanisms. + * Improved BaseHTTPRequestHandler and mod_python reliability around fields + from request bodies. + * Provided stream and environment parameterisation in the CGI adapter. + * Added LoginRedirect and Login examples. + * Added get_path_without_query and fixed get_path behaviour. New in WebStack 0.3 (Changes since WebStack 0.2) ------------------------------------------------ -Added better header support for Webware (suggested by Ian Bicking). -Introduced CGI and Java Servlet support (the latter is currently -broken/unfinished). -Introduced support for cookies. + * Added better header support for Webware (suggested by Ian Bicking). + * Introduced CGI and Java Servlet support (the latter is currently + broken/unfinished). + * Introduced support for cookies. Future Work ----------- @@ -307,15 +312,15 @@ To make Debian packages: - 1. Create new package directories under packages/debian if necessary. - 2. Make a symbolic link in the distribution's root directory to keep the - Debian tools happy: + 1. Create new package directories under packages/debian if necessary. + 2. Make a symbolic link in the distribution's root directory to keep the + Debian tools happy: - ln -s packages/debian/python2.4-webstack/debian/ + ln -s packages/debian/python2.4-webstack/debian/ - 3. Run the package builder: + 3. Run the package builder: - dpkg-buildpackage -rfakeroot + dpkg-buildpackage -rfakeroot - 4. Locate and tidy up the packages in the parent directory of the - distribution's root directory. + 4. Locate and tidy up the packages in the parent directory of the + distribution's root directory.