<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <link rel="STYLESHEET" href="modpython.css" type='text/css' /> <link rel="first" href="modpython.html" title='Mod_python Manual' /> <link rel='contents' href='contents.html' title="Contents" /> <link rel='index' href='genindex.html' title='Index' /> <link rel='last' href='about.html' title='About this document...' /> <link rel='help' href='about.html' title='About this document...' /> <link rel="next" href="hand-pub-alg-args.html" /> <link rel="prev" href="hand-pub-alg.html" /> <link rel="parent" href="hand-pub-alg.html" /> <link rel="next" href="hand-pub-alg-args.html" /> <meta name='aesop' content='information' /> <title>7.1.2.1 Traversal</title> </head> <body> <DIV CLASS="navigation"> <div id='top-navigation-panel' xml:id='top-navigation-panel'> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td class='online-navigation'><a rel="prev" title="7.1.2 The Publishing Algorithm" href="hand-pub-alg.html"><img src='previous.png' border='0' height='32' alt='Previous Page' width='32' /></A></td> <td class='online-navigation'><a rel="parent" title="7.1.2 The Publishing Algorithm" href="hand-pub-alg.html"><img src='up.png' border='0' height='32' alt='Up One Level' width='32' /></A></td> <td class='online-navigation'><a rel="next" title="7.1.2.2 Argument Matching and" href="hand-pub-alg-args.html"><img src='next.png' border='0' height='32' alt='Next Page' width='32' /></A></td> <td align="center" width="100%">Mod_python Manual</td> <td class='online-navigation'><a rel="contents" title="Table of Contents" href="contents.html"><img src='contents.png' border='0' height='32' alt='Contents' width='32' /></A></td> <td class='online-navigation'><img src='blank.png' border='0' height='32' alt='' width='32' /></td> <td class='online-navigation'><a rel="index" title="Index" href="genindex.html"><img src='index.png' border='0' height='32' alt='Index' width='32' /></A></td> </tr></table> <div class='online-navigation'> <b class="navlabel">Previous:</b> <a class="sectref" rel="prev" href="hand-pub-alg.html">7.1.2 The Publishing Algorithm</A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="hand-pub-alg.html">7.1.2 The Publishing Algorithm</A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="hand-pub-alg-args.html">7.1.2.2 Argument Matching and</A> </div> <hr /></div> </DIV> <!--End of Navigation Panel--> <H3><A NAME="SECTION009121000000000000000"></A><A NAME="hand-pub-alg-trav"></A> <BR> 7.1.2.1 Traversal </H3> <P> The Publisher handler locates and imports the module specified in the URI. The module location is determined from the <tt class="class">req.filename</tt> attribute. Before importing, the file extension, if any, is discarded. <P> If <tt class="class">req.filename</tt> is empty, the module name defaults to "<tt class="samp">index</tt>". <P> Once module is imported, the remaining part of the URI up to the beginning of any query data (a.k.a. PATH_INFO) is used to find an object within the module. The Publisher handler <i class="dfn">traverses</i> the path, one element at a time from left to right, mapping the elements to Python object within the module. <P> If no path_info was given in the URL, the Publisher handler will use the default value of "<tt class="samp">index</tt>". If the last element is an object inside a module, and the one immediately preceding it is a directory (i.e. no module name is given), then the module name will also default to "<tt class="samp">index</tt>". <P> The traversal will stop and <tt class="constant">HTTP_NOT_FOUND</tt> will be returned to the client if: <P> <UL> <LI>Any of the traversed object's names begin with an underscore ("<tt class="samp">_</tt>"). Use underscores to protect objects that should not be accessible from the web. <P> </LI> <LI>A module is encountered. Published objects cannot be modules for security reasons. <P> </LI> </UL> <P> If an object in the path could not be found, <tt class="constant">HTTP_NOT_FOUND</tt> is returned to the client. <P> For example, given the following configuration: <P> <div class="verbatim"><pre> DocumentRoot /some/dir <Directory /some/dir> SetHandler mod_python PythonHandler mod_python.publisher </Directory> </pre></div> <P> And the following <span class="file">/some/dir/index.py</span> file: <P> <div class="verbatim"><pre> def index(req): return "We are in index()" def hello(req): return "We are in hello()" </pre></div> <P> Then: <P> http://www.somehost/index/index will return "<tt class="samp">We are in index()</tt>" <P> http://www.somehost/index/ will return "<tt class="samp">We are in index()</tt>" <P> http://www.somehost/index/hello will return "<tt class="samp">We are in hello()</tt>" <P> http://www.somehost/hello will return "<tt class="samp">We are in hello()</tt>" <P> http://www.somehost/spam will return "<tt class="samp">404 Not Found</tt>" <P> <DIV CLASS="navigation"> <div class='online-navigation'> <p></p><hr /> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td class='online-navigation'><a rel="prev" title="7.1.2 The Publishing Algorithm" href="hand-pub-alg.html"><img src='previous.png' border='0' height='32' alt='Previous Page' width='32' /></A></td> <td class='online-navigation'><a rel="parent" title="7.1.2 The Publishing Algorithm" href="hand-pub-alg.html"><img src='up.png' border='0' height='32' alt='Up One Level' width='32' /></A></td> <td class='online-navigation'><a rel="next" title="7.1.2.2 Argument Matching and" href="hand-pub-alg-args.html"><img src='next.png' border='0' height='32' alt='Next Page' width='32' /></A></td> <td align="center" width="100%">Mod_python Manual</td> <td class='online-navigation'><a rel="contents" title="Table of Contents" href="contents.html"><img src='contents.png' border='0' height='32' alt='Contents' width='32' /></A></td> <td class='online-navigation'><img src='blank.png' border='0' height='32' alt='' width='32' /></td> <td class='online-navigation'><a rel="index" title="Index" href="genindex.html"><img src='index.png' border='0' height='32' alt='Index' width='32' /></A></td> </tr></table> <div class='online-navigation'> <b class="navlabel">Previous:</b> <a class="sectref" rel="prev" href="hand-pub-alg.html">7.1.2 The Publishing Algorithm</A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="hand-pub-alg.html">7.1.2 The Publishing Algorithm</A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="hand-pub-alg-args.html">7.1.2.2 Argument Matching and</A> </div> </div> <hr /> <span class="release-info">Release 3.3.1, documentation updated on January 29, 2007.</span> </DIV> <!--End of Navigation Panel--> </BODY> </HTML>