[Twisted-web] Override File's DirectoryLister?

Philippe May phil.twisted-web at hanjinet.org
Sun Oct 28 14:46:00 EDT 2012

Hi Rich,

That's quite easy, it's just basic object oriented programing with Python, nothing directly related to Twisted:
import what you need, subclass the File and DirectoryLister, and override in those what is required to be changed.

Starting rom the code you mention, that gives the piece of code below (check the ## ** Comment ** parts).
Hope that helps you starting.


import os
import cgi
import urllib
import time

from twisted.web.server import Site
from twisted.web.resource import Resource
from twisted.internet import reactor
from twisted.web.static import File, DirectoryLister, getTypeAndEncoding, formatFileSize

class MyDirectoryLister(DirectoryLister):

    ## ** Comment **
    ##   Here you can change the way lines are displayed.
    ##   I just added the "mtime" field, see below how it is defined

    linePattern = """<tr class="%(class)s">
    <td><a href="%(href)s">%(text)s</a></td>

    ## ** Comment **
    ##   _getFilesAndDirectories is just a copy of the original function found in the File class,
    ##   with minor modifications

    def _getFilesAndDirectories(self, directory):
        Helper returning files and directories in given directory listing, with
        attributes to be used to build a table content with

        @return: tuple of (directories, files)
        @rtype: C{tuple} of C{list}

        files = []
        dirs = []
        for path in directory:
            ## ** Comment **
            ##   Do stuff with the file path
            ##   (eg filter 'hidden' files and get the modification time):
            if path[0] == ".":
            mtime = time.asctime(time.localtime(os.path.getmtime(os.path.join(self.path, path))))

            url = urllib.quote(path, "/")
            escapedPath = cgi.escape(path)
            if os.path.isdir(os.path.join(self.path, path)):
                url = url + '/'
                dirs.append({'text': escapedPath + "/", 'href': url,
                             'size': '', 'type': '[Directory]',
                             'encoding': '',
                             'mtime': mtime
                mimetype, encoding = getTypeAndEncoding(path, self.contentTypes,
                    size = os.stat(os.path.join(self.path, path)).st_size
                except OSError:

                ## ** Comment **
                ##   Add attributes the the "elements" displayed in each line

                    'text': escapedPath, "href": url,
                    'type': '[%s]' % mimetype,
                    'encoding': (encoding and '[%s]' % encoding or ''),
                    'size': formatFileSize(size),
                    'mtime': mtime,
        return dirs, files

class MyFile(File):

    ## ** Comment **
    ##   You need need of course to subclass File, and change the minimum required to use your
    ##   DirectoryLister

    def directoryListing(self):
        return MyDirectoryLister(self.path,

root = Resource()
## ** Comment **
##   Of course, don't forget to use your class:
root.putChild("foo", MyFile("/tmp"))
root.putChild("bar", MyFile("/lost+found"))
root.putChild("baz", MyFile("/opt"))

factory = Site(root)
reactor.listenTCP(8880, factory)

Le 28 oct. 2012 à 22:32, Rich Brown a écrit :

> Folks,
> I'm new to Twisted and it looks like a good way to add a web server to my existing project. I am successfully following the example at http://twistedmatrix.com/documents/current/web/howto/web-in-60/static-dispatch.html to display the directories with the default file listing code.
> Now I want to modify that default behavior for directory listing to:
> - filter out/exclude certain kinds of files (e.g., by the extension), and 
> - add a few elements to the HTML page displayed.
> I've read the code of static.py, and see that the the DirectoryLister class seems to govern this. I believe I need to make a subslass, but I'm not a strong Python programmer, so the minor variations I tried kept running amiss of the class hierarchy, etc.
> Could someone give me an outline of the method declarations that are needed to get the behavior above? Many thanks.
> Rich Brown
> Hanover, NH USA
> _______________________________________________
> Twisted-web mailing list
> Twisted-web at twistedmatrix.com
> http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-web

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://twistedmatrix.com/pipermail/twisted-web/attachments/20121029/a4ab67f8/attachment.htm 

More information about the Twisted-web mailing list