Mod_python Documentation

This document aims to be the only necessary and authoritative source of information about mod_python, usable as a comprehensive reference, a user guide and a tutorial all-in-one.

See also

Python Language Web Site

for information on the Python language

Apache HTTP Server Project Web Site

for information on the Apache server

• Introduction
  • Performance
  • Apache HTTP Server API
  • Other Features
• Installation
  • Prerequisites
  • Compiling
    • Running ./configure
    • Running make
  • Installing
  • Configuring Apache
  • Testing
  • Troubleshooting
• Tutorial
  • A Quick Start with the Publisher Handler
  • Quick Overview of how Apache Handles Requests
  • So what Exactly does Mod-python do?
  • Now something More Complicated - Authentication
  • Your Own 404 Handler
• Python API
  • Multiple Interpreters
  • Overview of a Request Handler
  • Overview of a Filter Handler
  • Overview of a Connection Handler
  • apache – Access to Apache Internals.
    • Functions
      • log_error()
      • import_module()
      • allow_methods()
      • exists_config()
      • stat()
      • register_cleanup()
      • config_tree()
      • server_root()
      • make_table()
      • mpm_query()
    • Attributes
      • interpreter
      • main_server
      • MODULE_MAGIC_NUMBER_MAJOR
      • MODULE_MAGIC_NUMBER_MINOR
    • Table Object (mp_table)
      • table
        • table.add()
    • Request Object
      • Request Methods
        • request.add_cgi_vars()
        • request.add_common_vars()
        • request.add_handler()
        • request.add_input_filter()
        • request.add_output_filter()
        • request.allow_methods()
        • request.auth_name()
        • request.auth_type()
        • request.construct_url()
        • request.discard_request_body()
        • request.document_root()
        • request.get_basic_auth_pw()
        • request.get_config()
        • request.get_remote_host()
        • request.get_options()
        • request.internal_redirect()
        • request.is_https()
        • request.log_error()
        • request.meets_conditions()
        • request.requires()
        • request.read()
        • request.readline()
        • request.readlines()
        • request.register_cleanup()
        • request.register_input_filter()
        • request.register_output_filter()
        • request.sendfile()
        • request.set_etag()
        • request.set_last_modified()
        • request.ssl_var_lookup()
        • request.update_mtime()
        • request.write()
        • request.flush()
        • request.set_content_length()
      • Request Members
        • request.connection
        • request.server
        • request.next
        • request.prev
        • request.main
        • request.the_request
        • request.assbackwards
        • request.proxyreq
        • request.header_only
        • request.protocol
        • request.proto_num
        • request.hostname
        • request.request_time
        • request.status_line
        • request.status
        • request.method
        • request.method_number
        • request.allowed
        • request.allowed_xmethods
        • request.allowed_methods
        • request.sent_bodyct
        • request.bytes_sent
        • request.mtime
        • request.chunked
        • request.range
        • request.clength
        • request.remaining
        • request.read_length
        • request.read_body
        • request.read_chunked
        • request.expecting_100
        • request.headers_in
        • request.headers_out
        • request.err_headers_out
        • request.subprocess_env
        • request.notes
        • request.phase
        • request.interpreter
        • request.content_type
        • request.content_languages
        • request.handler
        • request.content_encoding
        • request.vlist_validator
        • request.user
        • request.ap_auth_type
        • request.no_cache
        • request.no_local_copy
        • request.unparsed_uri
        • request.uri
        • request.filename
        • request.canonical_filename
        • request.path_info
        • request.args
        • request.finfo
        • request.parsed_uri
        • request.used_path_info
        • request.eos_sent
        • request.useragent_addr
        • request.useragent_ip
    • Connection Object (mp_conn)
      • Connection Methods
        • connection.log_error()
        • connection.read()
        • connection.readline()
        • connection.write()
      • Connection Members
        • connection.base_server
        • connection.local_addr
        • connection.remote_addr
        • connection.client_addr
        • connection.remote_ip
        • connection.client_ip
        • connection.remote_host
        • connection.remote_logname
        • connection.aborted
        • connection.keepalive
        • connection.double_reverse
        • connection.keepalives
        • connection.local_ip
        • connection.local_host
        • connection.id
        • connection.notes
    • Filter Object (mp_filter)
      • Filter Methods
        • filter.pass_on()
        • filter.read()
        • filter.readline()
        • filter.write()
        • filte.flush()
        • filter.close()
        • filter.disable()
      • Filter Members
        • filter.closed
        • filter.name
        • filter.req
        • filter.is_input
        • filter.handler
      • Server Object (mp_server)
      • Server Methods
        • server.get_config()
        • server.get_options()
        • server.log_error()
        • server.register_cleanup()
      • Server Members
        • server.defn_name
        • server.defn_line_number
        • server.server_admin
        • server.server_hostname
        • server.names
        • server.wild_names
        • server.port
        • server.error_fname
        • server.loglevel
        • server.is_virtual
        • server.timeout
        • server.keep_alive_timeout
        • server.keep_alive_max
        • server.keep_alive
        • server.path
        • server.pathlen
        • server.limit_req_line
        • server.limit_req_fieldsize
        • server.limit_req_fields
  • util – Miscellaneous Utilities
    • FieldStorage class
      • FieldStorage
        • FieldStorage.list
      • FieldStorage methods
        • add_field()
        • clear()
        • get()
        • getfirst()
        • getlist()
        • has_key()
        • items()
        • keys()
    • FieldStorage Examples
      • Simple file control using class constructor
      • Advanced file control using object factory
    • Field class
      • Field
        • Field.name
        • Field.value
        • Field.file
        • Field.filename
        • Field.type
        • Field.type_options
        • Field.disposition
        • Field.disposition_options
    • Other functions
      • parse_qs()
      • parse_qsl()
      • redirect()
  • Cookie – HTTP State Management
    • Classes
      • Cookie
        • Cookie.parse()
      • SignedCookie
        • SignedCookie.parse()
      • MarshalCookie
      • Functions
        • add_cookie()
        • get_cookies()
        • get_cookie()
    • Examples
  • Session – Session Management
    • Classes
      • Session()
      • BaseSession
        • BaseSession.is_new()
        • BaseSession.id()
        • BaseSession.created()
        • BaseSession.last_accessed()
        • BaseSession.timeout()
        • BaseSession.set_timeout()
        • BaseSession.invalidate()
        • BaseSession.load()
        • BaseSession.save()
        • BaseSession.delete()
        • BaseSession.init_lock()
        • BaseSession.lock()
        • BaseSession.unlock()
        • BaseSession.cleanup()
      • DbmSession
      • FileSession
      • MemorySession
    • Examples
  • psp – Python Server Pager
    • PSP.run()
    • PSP.display_code()
    • PSPInterface
      • PSPInterface.set_error_page()
      • PSPInterface.apply_data()
      • PSPInterface.redirect()
    • parse()
    • parsestring()
  • httpdconf – HTTPd Configuration
    • Classes for Directive types
      • Directive
      • Container
        • Container.append()
      • Comment
• Apache Configuration Directives
  • Request Handlers
    • Python*Handler Directive Syntax
    • Python*Handlers and Python path
    • PythonPostReadRequestHandler
    • PythonTransHandler
    • PythonHeaderParserHandler
    • PythonInitHandler
    • PythonAccessHandler
    • PythonAuthenHandler
    • PythonAuthzHandler
    • PythonTypeHandler
    • PythonFixupHandler
    • PythonHandler
    • PythonLogHandler
    • PythonCleanupHandler
  • Filters
    • PythonInputFilter
    • PythonOutputFilter
  • Connection Handler
    • PythonConnectionHandler
  • Other Directives
    • PythonEnablePdb
    • PythonDebug
    • PythonImport
    • PythonInterpPerDirectory
    • PythonInterpPerDirective
    • PythonInterpreter
    • PythonHandlerModule
    • PythonAutoReload
    • PythonOptimize
    • PythonOption
      • Reserved PythonOption Keywords
    • PythonPath
• Standard Handlers
  • Publisher Handler
    • Introduction
    • The Publishing Algorithm
      • Traversal
      • Argument Matching and Invocation
      • Authentication
    • Form Data
  • WSGI Handler
  • PSP Handler
  • CGI Handler
• Command Line Tool - mod_python
  • Overview of mod_python command
  • mod_python command line tool sub-commands
    • create
    • genconfig
    • start
    • stop
    • restart
    • version
    • Example
• Server Side Includes
  • Overview of SSI
  • Using Python Code
  • Scope of Global Data
  • Pre-populating Globals
  • Conditional Expressions
  • Enabling INCLUDES Filter
• Changes
  • Changes from version 3.3.1
    • New Features
    • Improvements
    • Bug Fixes
  • Changes from version 3.2.10
    • New Features
    • Improvements
    • Bug Fixes
  • Changes from version 3.2.8
    • New Features
    • Improvements
    • Bug Fixes
  • Changes from version 3.2.7
    • Security Fix
  • Changes from version 3.1.4
    • New Features
    • Improvements
    • Bug Fixes
  • Changes from version 2.x
• History and License
  • History
  • License
• About these documents
• Copyright