While high-level templating systems can be used with Twisted (for example, -Divmod Nevow, sometimes -one needs a less file-heavy system which lets one directly write HTML. While -ResourceScripts are available, they have a high overhead of coding, needing -some boring string arithmetic. ResourceTemplates fill the space between Nevow -and ResourceScript using Quixote's PTL (Python Templating Language).
- -ResourceTemplates need Quixote installed. In
-Debian, that means using Python 2.2
-and installing the quixote package
-(apt-get install quixote). Other operating systems require
-other ways to install quixote, or it can be done manually.
While high-level templating systems can be used with Twisted (for +example, Divmod +Nevow, sometimes one needs a less file-heavy system which lets one +directly write HTML. While ResourceScripts are available, they have a +high overhead of coding, needing some boring string +arithmetic. ResourceTemplates fill the space between Nevow and +ResourceScript using Quixote's PTL (Python Templating Language).
+ +ResourceTemplates need Quixote
+installed. In Debian, that means
+using Python 2.2 and installing the quixote package
+(apt-get install quixote). Other operating systems
+require other ways to install quixote, or it can be done manually.
ResourceTemplates are coded in an extension of Python called the
Python Templating Language
. Complete documentation of the PTL
-is available at the quixote web site. The web server
-will expect the PTL source file to define a variable named
-resource.
-This should be a twisted.web.server.Resource,
+is available
+at the
+quixote web site. The web server will expect the PTL source file
+to define a variable named resource. This should be
+a twisted.web.server.Resource,
whose .render method be called. Usually, you would want
to define render using the keyword template
rather than def.
HTTPChannel instances to parse the HTTP request, and begin the object lookup process. They contain the root Resource, the resource which represents the URL / on the site.HTTPChannel instances to parse the HTTP request,
+and begin the object lookup process. They contain the root Resource,
+the resource which represents the URL / on the site.IResource interface describes the methods a Resource object must implement in order to participate in the object publishing process.When using twistd -n web --path /foo/bar/baz, a Site object is created with a root Resource that serves files out of the given path.
You can also create a Site instance by hand, passing it a
-Resource object which will serve as the root of the site:
You can also create a Site instance by hand, passing
+it a Resource object which will serve as the root of the
+site:
from twisted.web import server, resource @@ -173,18 +176,18 @@ resource = myresource.MyResource() The-Resourceclass, which is usually what one's Resource classes subclass, has a -convenient default implementation ofrender. It will call a method namedself.render_METHODwhereMETHODis -whatever HTTP method was used to request this resource. Examples: -request_GET, request_POST, request_HEAD, and so on. It is recommended -that you have your resource classes subclassResourceand implementrender_METHODmethods as opposed torenderitself. Note that for certain resources, -request_POST = request_GETmay be -desirable in case one wants to process arguments passed to the -resource regardless of whether they used GET +convenient default implementation +ofrender. It will call a method +namedself.render_METHOD+whereMETHODis whatever HTTP method was used to request this +resource. Examples: request_GET, request_POST, request_HEAD, and so +on. It is recommended that you have your resource classes +subclassResource+and implementrender_METHODmethods as +opposed torenderitself. Note that for +certain resources,request_POST = +request_GETmay be desirable in case one wants to process +arguments passed to the resource regardless of whether they used GET (?foo=bar&baz=quux, and so forth) or POST. @@ -201,13 +204,15 @@ resource regardless of whether they used GETAdvanced Configuration
Non-trivial configurations of Twisted Web are achieved with Python -configuration files. This is a Python snippet which builds up a variable -called application. Usually, a
+configuration files. This is a Python snippet which builds up a +variable called application. Usually, +atwisted.application.internet.TCPServerinstance will -be used to make the application listen on a TCP port (80, in case direct -web serving is desired), with the listener being a -twisted.web.server.Site. The resulting file can then -be run withtwistd -y. Alternatively a reactor -object can be used directly to make a runnable script.twisted.application.internet.TCPServer+instance will be used to make the application listen on a TCP port +(80, in case direct web serving is desired), with the listener being +atwisted.web.server.Site. The resulting file +can then be run withtwistd +-y. Alternatively a reactor object can be used directly to make +a runnable script.The
@@ -259,12 +264,13 @@ reactor.run()Sitewill wrap aResourceobject -- the root.Modifying File Resources
-+
Fileresources, be they root object or children thereof, -have two important attributes that often need to be modified: -indexNamesandprocessors.indexNames-determines which files are treated asindex files-- served -up when a directory is rendered.processorsdetermine how -certain file extensions are treated.
Fileresources, be they root object or children +thereof, have two important attributes that often need to be +modified:indexNames+andprocessors.indexNamesdetermines which +files are treated asindex files-- served up when a directory +is rendered.processorsdetermine how certain file +extensions are treated.Here is an example for both, creating a site where all
.rpyextensions are Resource Scripts, and which renders directories by @@ -308,11 +314,12 @@ exists.Virtual Hosts
-Virtual hosting is done via a special resource, that should be -used as the root resource --
+NameVirtualHost. -NameVirtualHosthas an attribute nameddefault, -which holds the default website. If a different root for some other -name is desired, theaddHostmethod should be called.Virtual hosting is done via a special resource, that should be used +as the root resource +--
NameVirtualHost.NameVirtualHosthas an +attribute nameddefault, which holds the default +website. If a different root for some other name is desired, +theaddHostmethod should be called.from twisted.application import internet, service @@ -529,12 +536,13 @@ it when it is not.-Serving PHP/Perl/CGI
-Everything related to CGI is located in the -
+twisted.web.twcgi, and it's here you'll find the classes that you -need to subclass in order to support the language of your (or somebody elses) -taste. You'll also need to create your own kind of resource if you are using a -non-unix operating system (such as Windows), or if the default resources has -wrong pathnames to the parsers.Everything related to CGI is located in +the
twisted.web.twcgi, and it's here you'll find the +classes that you need to subclass in order to support the language of +your (or somebody elses) taste. You'll also need to create your own +kind of resource if you are using a non-unix operating system (such as +Windows), or if the default resources has wrong pathnames to the +parsers.The following snippet is a .rpy that serves perl-files. Look at
@@ -643,9 +651,9 @@ from twisted.web import vhost resource = vhost.VHostMonsterResource()twisted.web.twcgifor more examples regarding twisted.web and CGI.Make sure the web server is configured with the correct processors for the -
+rpyextensions (the web server -twistd web --pathgenerates by default is so configured).Make sure the web server is configured with the correct processors +for the
rpyextensions (the web servertwistd web +--pathgenerates by default is so configured).From the Apache side, instead of using the following ProxyPass directive:
@@ -684,18 +692,18 @@ i.setServiceParent(sc)Rewriting URLs
-Sometimes it is convenient to modify the content of the -
Requestobject +Sometimes it is convenient to modify the content of +the
+either the URL, the similarity to Apache'sRequestobject before passing it on. Because this is most often used to rewrite -either the URL, the similarity to Apache'smod_rewritehas -inspired thetwisted.web.rewritemodule. Using -this module is done via wrapping a resource with a -twisted.web.rewrite.RewriterResourcewhich -then has rewrite rules. Rewrite rules are functions which accept a request -object, and possible modify it. After all rewrite rules run, the child -resolution chain continues as if the wrapped resource, rather than -theRewriterResource, -was the child.mod_rewrite+has inspired thetwisted.web.rewrite+module. Using this module is done via wrapping a resource with +atwisted.web.rewrite.RewriterResourcewhich +then has rewrite rules. Rewrite rules are functions which accept a +request object, and possible modify it. After all rewrite rules run, +the child resolution chain continues as if the wrapped resource, +rather than theRewriterResource, was the child.Here is an example, using the only rule currently supplied by Twisted itself:
@@ -704,12 +712,12 @@ itself: default_root = rewrite.RewriterResource(default, rewrite.tildeToUsers)
This causes the URL /~foo/bar.html to be treated like
-/users/foo/bar.html. If done after setting default's
-users child to a
-distrib.UserDirectory,
-it gives a configuration similar to the classical configuration of
-web server, common since the first NCSA servers.
This causes the URL /~foo/bar.html to be treated
+like /users/foo/bar.html. If done after setting
+default's users child to a distrib.UserDirectory, it gives a
+configuration similar to the classical configuration of web server,
+common since the first NCSA servers.
Sometimes, you want to be able to send headers and status directly. While
-you can do this with a
-ResourceScript, an easier
-way is to use ASISProcessor.
-Use it by, for example, adding it as a processor for the .asis
-extension. Here is a sample file:
Sometimes, you want to be able to send headers and status
+directly. While you can do this with a ResourceScript, an easier way is to
+use ASISProcessor.
+Use it by, for example, adding it as a processor for
+the .asis extension. Here is a sample file:
HTTP/1.0 200 OK diff --git a/doc/web/howto/web-development.xhtml b/doc/web/howto/web-development.xhtml index 0a987d1..562cccf 100644 --- a/doc/web/howto/web-development.xhtml +++ b/doc/web/howto/web-development.xhtml @@ -82,12 +82,13 @@ all importing some Python module. This is a bad idea -- it mashes deployment with development, and makes sure your users will be tied to the file-system. -We have
+.rpys because they are useful and necessary. But using -them incorrectly leads to horribly unmaintainable applications. The best way to -ensure you are using them correctly is to not use them at all, until you are on -your final deployment stages. You should then find your -.rpyfiles will be less than 10 lines, because you will not -have more than 10 lines to write.We have
.rpys because they are useful and necessary. +But using them incorrectly leads to horribly unmaintainable +applications. The best way to ensure you are using them correctly is +to not use them at all, until you are on your final +deployment stages. You should then find your.rpyfiles +will be less than 10 lines, because you will not have more +than 10 lines to write.