Future Work
+++++++++++

Webware for Python

:Version: 1.0rc1
:Released: 06/06/08


Warning
=======

This document is mostly outdated and out of touch with development.
You can find better information about known bugs and future work
in the Wiki__ and in the `SourceForge tracker systems`__,
both accessible from the `Webware Home Page`__.
The SourceForge task manager is currently not used since these systems should
be sufficient and we do not want to scatter issues in too many systems.

__ http://wiki.w4py.org
__ http://sourceforge.net/tracker/?group_id=4866
__ http://www.webwareforpython.org


Future Work/Limitations
=======================

Sprinkled throughout the code are comments tagged with ``@@`` which are
hopefully accompanied by a date and someone's initials. These comments
represent things to be done. The double at-sign (``@@``) convention was
chosen because it doesn't appear to be used for anything else.

In addition to the inline comments, some significant items have been
recorded below. These are future ideas, with no commitments or timelines
as to when/if they'll be realized. The Python WebKit is open source,
so feel free to jump in!


Known Bugs
----------

All major known bugs that existed previously have been fixed.


To Do
-----


Major Items
~~~~~~~~~~~

* Drop backward compatibility down to Python 2.0; require at least 2.4.
  Make use of the new Python features like new-style classes, properties,
  sets, decorators, generator expressions, isinstace(tuple) etc. and get
  rid of old garbage and workarounds for old Python versions. Think about
  a migration path towards Pyhon 3.0.

* Use distutils/setuptools instead of our own installer, use Python eggs
  instead of our own plug-in concept.

* The installer could try building and/or installing mod_webkit and wkcgi
  automatically.

* Separate more clearly and systematically which messages are printed to
  stdout and which to stderr.

* Make use of the logging module (so far it is only used with unit testing)
  instead of conditional print statements with "debug" and "verbose" flags.

* CheckSource.py: A program to check the source code conventions.

* Role-based security and user-authentication. Goal is to eliminate,
  as much as possible, developer-written security logic.
  This should be provided by the WebKit and be configurable.

* Write a custom adaptor for Apache, Netscape, MS, etc.

* Distribution and load balancing.

* Fault tolerance.

* More sophisticated admin tools including password protection,
  clearing logs, displaying a maximum of information at a time, etc.
  Consider using module 'resource'.

* Investigate case insensitive URLs, especially for the Windows platform.

* Support unicode strings and different encodings. HTTPContent should get an
  encoding attribute with 'utf-8' as the default (set in Application.config).
  This could be output in Page.writeMetaData() and used as the default for
  an optional encoding parameter in HTTPContent.write(), so you can write
  unicode strings to output. So far, Webware works best if you use ordinary
  strings with a consistent encoding throughout the whole application.

* Plug-ins:

  * In ExamplePage, automatically support examples of any plug-in
  * Better docs
  * Properties.config. 'Load', 0, 1 or the name of the required op sys


General
~~~~~~~

* Hunt down: ``@@`` tags (which signify "To Be Done"s), ``FUTURE`` items
  in class doc strings, ``NotImplementedErrors``, ``--`` tags

* Code clean up.

* Right now, if the Application itself (as opposed to Servlets) throws
  an exception, it doesn't get captured nicely. However, it is displayed
  in the app server's console.

* The exception handler is pretty nice and has features like logging,
  e-mail, gathering debugging info, etc.
  However, on occasions it can throw exceptions too.
  There should be a simpler, secondary exception handler for when this happens.

* Review the timestamp caching logic and its relation to .pyc files if any.

* Add "Last-modified:" to generic files that are served via WebKit.

* If a Python file has only one class that inherits from Servlet,
  then use that as the Servlet class
  (rather than requiring the name be the same as the file).


Testing
~~~~~~~

* Provide testing web page where people can report their testing results
  including version numbers, etc.

* Provide higher level automation of testing. For example, a testing script
  should be able to launch various app servers multiple times.

* Provide highly automated benchmarking so we can track changes in performance.

* Add more unit tests, expand the regression test suite.


Docs
~~~~

* Add a Getting Started Guide and a screencast.

* Beef up the User's Guide and Tutorial.

* User's Guide: Create a caching section to discuss the virtues of doing so
  (the Color example became 12 X faster on the server side).

* Use better tools such as DocUtils, Epydoc or Sphinx for creating the
  documentation, instead of our tools in the DocSupport folder.


Food for thought, considerations, reviews
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Consider including FormKit, FunFormKit or FormEncode:
  A plug-in to aid the construction and validation of forms.

* Consider adding a simple helper lib for generating HTML
  (such as SimpleHTMLGen) to the WebUtils package.

* Support `WSGI <http://www.python.org/dev/peps/pep-0333/>`__.

* Consider this statement from the FastCGI docs:
  "Redirects are handled similar to CGI. Location headers with values
  that begin with "/" are treated as internal-redirects; otherwise,
  they are treated as external redirects (302)."

* FastCGI app server:
  The idea is that if the app server itself supports FastCGI,
  then it can be used directly with FastCGI enabled web servers
  sans the infamous "adapter".
  Dan Green has brought this up in Webware-discuss.

* Consider if we need to support ``<form action="x.py?a=1" method="post">``
  where you will have both a query string and posted data.

* Application modifies sys.path so that servlets can say
  ``from SuperServlet import SuperServlet`` where SuperServlet is located in
  the same directory as the Servlet. We'd prefer a more sophisticated technique
  which does not modify sys.path and does not affect other servlets. (Or maybe
  this would go away with a new one-process-per-application architecture.)

* The ThreadedAppServer is not optimal for multiprocessor systems and modern
  multi-core CPUs, due to the Python GIL.


Check out
~~~~~~~~~

* `Python Paste <http://pythonpaste.org>`__

* `Django <http://www.djangoproject.com>`__,
  `TurboGears <http://www.turbogears.org>`__,
  `Pylons <http://pylonshq.com>`__,
  `web.py <http://webpy.org>`__

* `Aquarium <http://aquarium.sourceforge.net>`__

* http://www.zope.org/Members/Amos/WhatIsAcquisition

* http://www.zope.org/Members/jim/Info/IPC8/AcquisitionAlgebra/index.html

* FastCGI related: http://www.tfarmbruster.com/fcgi_sa.htm


Down the road
~~~~~~~~~~~~~

* Multi-language support/localization (e.g., vend data to clients
  in their preferred written language)

* Consider CORBA standard RMI-IIOP and it's potential interaction with WebKit.
  This technology has been marked for inclusion in J2EE. I imagine the idea
  might be that an app server could be used by more than just web browsers.
  e.g., it could be used programmatically
  (in a more natural way than simulating a web client).
