File: directives.rst

package info (click to toggle)
libapache2-mod-python 3.5.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,864 kB
  • sloc: python: 7,471; ansic: 7,025; makefile: 296; lex: 246; sh: 212
file content (987 lines) | stat: -rw-r--r-- 38,456 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987

.. |br| raw:: html

   <br />

.. _directives:

*******************************
Apache Configuration Directives
*******************************

.. _dir-handlers:

Request Handlers
================

.. _dir-handlers-syn:

Python*Handler Directive Syntax
-------------------------------

.. index::
   single: Python*Handler Syntax


All request handler directives have the following syntax:

``Python*Handler handler [handler ...] [ | .ext [.ext ...] ]``

Where *handler* is a callable object that accepts a single argument -
request object, and *.ext* is an optional file extension.

Multiple handlers can be specified on a single line, in which case
they will be called sequentially, from left to right. Same handler
directives can be specified multiple times as well, with the same
result - all handlers listed will be executed sequentially, from first
to last.

If any handler in the sequence returns a value other than
``apache.OK`` or ``apache.DECLINED``, then execution of all subsequent
handlers for that phase is aborted. What happens when either
``apache.OK`` or ``apache.DECLINED`` is returned is dependent on which
phase is executing.

Note that prior to mod_python 3.3, if any handler in the sequence, no
matter which phase was executing, returned a value other than
``apache.OK``, then execution of all subsequent handlers for that phase
was aborted.

The list of handlers can optionally be followed by a ``|`` followed
by one or more file extensions. This would restrict the execution of
the handler to those file extensions only. This feature only works for
handlers executed after the trans phase.

A *handler* has the following syntax:

``module[::object]``

Where *module* can be a full module name (package dot notation is
accepted) or an actual path to a module code file. The module is loaded
using the mod_python module importer as implemented by the
``apache.import_module()`` function. Reference should be made to
the documentation of that function for further details of how module
importing is managed.

The optional *object* is the name of an object inside the module.
Object can also contain dots, in which case it will be resolved from
left to right. During resolution, if mod_python encounters an object
of type ``<class>``, it will try instantiating it passing it a single
argument, a request object.

If no object is specified, then it will default to the directive of
the handler, all lower case, with the word ``'python'``
removed. E.g. the default object for PythonAuthenHandler would be
authenhandler.

Example::

   PythonAuthzHandler mypackage.mymodule::checkallowed

For more information on handlers, see :ref:`pyapi-handler`.

.. note:: The ``'::'`` was chosen for performance reasons. In order
   for Python to use objects inside modules, the modules first need to
   be imported. Having the separator as simply a ``'.'``, would
   considerably complicate process of sequentially evaluating every
   word to determine whether it is a package, module, class etc. Using
   the (admittedly un-Python-like) ``'::'`` removes the time-consuming
   work of figuring out where the module part ends and the object
   inside of it begins, resulting in a modest performance gain.

.. index::
   pair: phase; order

The handlers in this document are listed in order in which phases are
processed by Apache.

.. _dir-handlers-pp:

Python*Handlers and Python path
-------------------------------

.. index::
   pair: pythonpath, Python*Handler

If a ``Python*Handler`` directive is specified in a *directory section*
(i.e. inside a ``<Directory></Directory>`` or
``<DirectoryMatch></DirectoryMatch>`` or in an ``.htaccess`` file),
then this directory is automatically prepended to the Python path
(``sys.path``) *unless* Python path is specified explicitely with the
``PythonPath`` directive.

If a ``Python*Handler`` directive is specified in a *location section*
(i.e. inside ``<Location></Location>`` or
``<LocationMatch></LocationMatch>``), then no path modification is done
automatically and in most cases a ``PythonPath`` directive is required
to augment the path so that the handler module can be imported.

Also for ``Python*Handlers`` inside a location section mod_python
disables the phase of the request that maps the URI to a file on the
filesystem (``ap_hook_map_to_storage``). This is because there is
usually no link between path specified in ``<Location>`` and the
filesystem, while attempting to map to a filesystem location results
in unnecessary and expensive filesystem calls. Note that an important
side-effect of this is that once a request URI has been matched to a
``<Location>`` containing a mod_python handler, all ``<Directory>``
and ``<DirectoryMatch>`` directives and their contents are ignored for
this request.

.. _dir-handlers-prrh:

PythonPostReadRequestHandler
----------------------------

.. index::
   single: PythonPostReadRequestHandler

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This handler is called after the request has been read but before any
other phases have been processed. This is useful to make decisions
based upon the input header fields.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.OK`` or ``apache.DECLINED``, then
execution of all subsequent handlers for this phase is aborted.

.. note::

   When this phase of the request is processed, the URI has not yet
   been translated into a path name, therefore this directive could
   never be executed by Apache if it could specified within
   ``<Directory>``, ``<Location>``, ``<File>`` directives or in an
   :file:`.htaccess` file. The only place this directive is allowed is
   the main configuration file, and the code for it will execute in
   the main interpreter. And because this phase happens before any
   identification of the type of content being requested is done
   (i.e. is this a python program or a gif?), the python routine
   specified with this handler will be called for *ALL* requests on
   this server (not just python programs), which is an important
   consideration if performance is a priority.



.. _dir-handlers-th:

PythonTransHandler
------------------

.. index::
   single: PythonTransHandler



`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|

This handler allows for an opportunity to translate the URI into
an actual filename, before the server's default rules (Alias
directives and the like) are followed.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.DECLINED``, then execution of all
subsequent handlers for this phase is aborted.

.. note::

   At the time when this phase of the request is being processed, the
   URI has not been translated into a path name, therefore this
   directive will never be executed by Apache if specified within
   ``<Directory>``, ``<Location>``, ``<File>`` directives or in an
   :file:`.htaccess` file. The only place this can be specified is the
   main configuration file, and the code for it will execute in the
   main interpreter.


.. _dir-handlers-hph:

PythonHeaderParserHandler
-------------------------

.. index::
   single: PythonHeaderParserHandler

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This handler is called to give the module a chance to look at the
request headers and take any appropriate specific actions early in the
processing sequence.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.OK`` or ``apache.DECLINED``, then
execution of all subsequent handlers for this phase is aborted.


.. _dir-handlers-pih:

PythonInitHandler
------------------

.. index::
   single: PythonInitHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This handler is the first handler called in the request processing
phases that is allowed both inside and outside :file`.htaccess` and
directory.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.OK`` or ``apache.DECLINED``, then
execution of all subsequent handlers for this phase is aborted.

This handler is actually an alias to two different handlers. When
specified in the main config file outside any directory tags, it is an
alias to ``PostReadRequestHandler``. When specified inside directory
(where ``PostReadRequestHandler`` is not allowed), it aliases to
``PythonHeaderParserHandler``.

\*(This idea was borrowed from mod_perl)


.. _dir-handlers-ach:

PythonAccessHandler
-------------------

.. index::
   single: PythonAccessHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This routine is called to check for any module-specific restrictions
placed upon the requested resource.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.OK`` or ``apache.DECLINED``, then
execution of all subsequent handlers for this phase is aborted.

For example, this can be used to restrict access by IP number. To do
so, you would return ``HTTP_FORBIDDEN`` or some such to indicate
that access is not allowed.

.. _dir-handlers-auh:

PythonAuthenHandler
-------------------

.. index::
   single: PythonAuthenHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This routine is called to check the authentication information sent
with the request (such as looking up the user in a database and
verifying that the [encrypted] password sent matches the one in the
database).

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.DECLINED``, then execution of all
subsequent handlers for this phase is aborted.

To obtain the username, use ``req.user``. To obtain the password
entered by the user, use the :meth:`request.get_basic_auth_pw` function.

A return of ``apache.OK`` means the authentication succeeded. A return
of ``apache.HTTP_UNAUTHORIZED`` with most browser will bring up the
password dialog box again. A return of ``apache.HTTP_FORBIDDEN`` will
usually show the error on the browser and not bring up the password
dialog ``again. HTTP_FORBIDDEN`` should be used when authentication
succeeded, but the user is not permitted to access a particular URL.

An example authentication handler might look like this::

   def authenhandler(req):

       pw = req.get_basic_auth_pw()
       user = req.user
       if user == "spam" and pw == "eggs":
           return apache.OK
       else:
           return apache.HTTP_UNAUTHORIZED

.. note::

   :meth:`request.get_basic_auth_pw` must be called prior to using the
   :attr:`request.user` value. Apache makes no attempt to decode the
   authentication information unless :meth:`request.get_basic_auth_pw` is called.


.. _dir-handlers-auzh:

PythonAuthzHandler
-------------------

.. index::
   single: PythonAuthzHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This handler runs after AuthenHandler and is intended for checking
whether a user is allowed to access a particular resource. But more
often than not it is done right in the AuthenHandler.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.DECLINED``, then execution of all
subsequent handlers for this phase is aborted.

.. _dir-handlers-tph:

PythonTypeHandler
-------------------

.. index::
   single: PythonTypeHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This routine is called to determine and/or set the various document
type information bits, like Content-type (via ``r->content_type``),
language, et cetera.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.DECLINED``, then execution of all
subsequent handlers for this phase is aborted.


.. _dir-handlers-fuh:

PythonFixupHandler
-------------------

.. index::
   single: PythonFixupHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This routine is called to perform any module-specific fixing of header
fields, et cetera. It is invoked just before any content-handler.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.OK`` or ``apache.DECLINED``, then
execution of all subsequent handlers for this phase is aborted.

.. _dir-handlers-ph:

PythonHandler
-------------

.. index::
   single: PythonHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This is the main request handler. Many applications will only provide
this one handler.

Where multiple handlers are specified, if any handler in the sequence
returns a status value other than ``apache.OK`` or
``apache.DECLINED``, then execution of subsequent handlers for the phase
are skipped and the return status becomes that for the whole content
handler phase. If all handlers are run, the return status of the final
handler is what becomes the return status of the whole content handler
phase. Where that final status is ``apache.DECLINED``, Apache will fall
back to using the ``default-handler`` and attempt to serve up the target
as a static file.

.. _dir-handlers-plh:

PythonLogHandler
----------------

.. index::
   single: PythonLogHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This routine is called to perform any module-specific logging
activities.

Where multiple handlers are specified, if any handler in the sequence
returns a value other than ``apache.OK`` or ``apache.DECLINED``, then
execution of all subsequent handlers for this phase is aborted.

.. _dir-handlers-pch:

PythonCleanupHandler
--------------------

.. index::
   single: PythonCleanupHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ *Python\*Handler Syntax* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


This is the very last handler, called just before the request object
is destroyed by Apache.

Unlike all the other handlers, the return value of this handler is
ignored. Any errors will be logged to the error log, but will not be
sent to the client, even if PythonDebug is On.

This handler is not a valid argument to the ``rec.add_handler()``
function. For dynamic clean up registration, use
``req.register_cleanup()``.

Once cleanups have started, it is not possible to register more of
them. Therefore, ``req.register_cleanup()`` has no effect within this
handler.

Cleanups registered with this directive will execute *after* cleanups
registered with ``req.register_cleanup()``.

.. _dir-filter:

Filters
=======

.. _dir-filter-if:

PythonInputFilter
-----------------

.. index::
   single: PythonInputFilter


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonInputFilter handler name |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Registers an input filter *handler* under name *name*. *Handler* is a
module name optionally followed ``::`` and a callable object name. If
callable object name is omitted, it will default to
``'inputfilter'``. *Name* is the name under which the filter is
registered, by convention filter names are usually in all caps.

The *module* referred to by the handler can be a full module name
(package dot notation is accepted) or an actual path to a module code file.
The module is loaded using the mod_python module importer as implemented by
the :func:`apache.import_module` function. Reference should be made to the
documentation of that function for further details of how module importing
is managed.

To activate the filter, use the ``AddInputFilter`` directive.

.. _dir-filter-of:

PythonOutputFilter
------------------

.. index::
   single: PythonOutputFilter


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonOutputFilter handler name |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Registers an output filter *handler* under name *name*. *handler* is a
module name optionally followed ``::`` and a callable object name. If
callable object name is omitted, it will default to
``'outputfilter'``. *name* is the name under which the filter is
registered, by convention filter names are usually in all caps.

The *module* referred to by the handler can be a full module name
(package dot notation is accepted) or an actual path to a module code file.
The module is loaded using the mod_python module importer as implemented by
the :func:`apache.import_module` function. Reference should be made to the
documentation of that function for further details of how module importing
is managed.

To activate the filter, use the ``AddOutputFilter`` directive.

.. _dir-conn:

Connection Handler
==================

.. _dir-conn-ch:

PythonConnectionHandler
-----------------------

.. index::
   single: PythonConnectionHandler


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonConnectionHandler handler |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Specifies that the connection should be handled with *handler*
connection handler. *handler* will be passed a single argument -
the connection object.

*Handler* is a module name optionally followed ``::`` and a
callable object name. If callable object name is omitted, it will
default to ``'connectionhandler'``.

The *module* can be a full module name (package dot notation is
accepted) or an absolute path to a module code file. The module is loaded
using the mod_python module importer as implemented by the
:func:`apache.import_module` function. Reference should be made to the
documentation of that function for further details of how module importing
is managed.

.. _dir-other:

Other Directives
==================

.. _dir-other-epd:

PythonEnablePdb
---------------

.. index::
   single: PythonEnablePdb


`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonEnablePdb {On, Off} |br|
`Default: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Default>`_ PythonEnablePdb Off |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


When On, mod_python will execute the handler functions within the
Python debugger pdb using the :func:`pdb.runcall` function.

Because pdb is an interactive tool, start httpd from the command line
with the ``-DONE_PROCESS`` option when using this directive. As soon as
your handler code is entered, you will see a Pdb prompt allowing you
to step through the code and examine variables.

.. _dir-other-pd:

PythonDebug
-----------

.. index::
   single: PythonDebug

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonDebug {On, Off} |br|
`Default: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Default>`_ PythonDebug Off |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Normally, the traceback output resulting from uncaught Python errors
is sent to the error log. With PythonDebug On directive specified, the
output will be sent to the client (as well as the log), except when
the error is :exc:`IOError` while writing, in which case it will go
to the error log.

This directive is very useful during the development process. It is
recommended that you do not use it production environment as it may
reveal to the client unintended, possibly sensitive security
information.

.. _dir-other-pimp:

PythonImport
------------

.. index::
   single: PythonImport

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonImport *module* *interpreter_name* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Tells the server to import the Python module module at process startup
under the specified interpreter name. The import takes place at child
process initialization, so the module will actually be imported once for
every child process spawned.

The *module* can be a full module name (package dot notation is
accepted) or an absolute path to a module code file. The module is loaded
using the mod_python module importer as implemented by the
:func:`apache.import_module` function. Reference should be made to
the documentation of that function for further details of how module
importing is managed.

The ``PythonImport`` directive is useful for initialization tasks that
could be time consuming and should not be done at the time of processing a
request, e.g. initializing a database connection. Where such initialization
code could fail and cause the importing of the module to fail, it should be
placed in its own function and the alternate syntax used:

``PythonImport *module::function* *interpreter_name*``

The named function will be called only after the module has been imported
successfully. The function will be called with no arguments.

.. note::

   At the time when the import takes place, the configuration is not
   completely read yet, so all other directives, including
   PythonInterpreter have no effect on the behavior of modules
   imported by this directive. Because of this limitation, the
   interpreter must be specified explicitly, and must match the name
   under which subsequent requests relying on this operation will
   execute. If you are not sure under what interpreter name a request
   is running, examine the :attr:`request.interpreter` member of the request
   object.

See also Multiple Interpreters.

.. _dir-other-ipd:

PythonInterpPerDirectory
------------------------

.. index::
   single: PythonInterpPerDirectory

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonInterpPerDirectory {On, Off} |br|
`Default: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Default>`_ PythonInterpPerDirectory Off |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Instructs mod_python to name subinterpreters using the directory of
the file in the request (``req.filename``) rather than the the
server name. This means that scripts in different directories will
execute in different subinterpreters as opposed to the default policy
where scripts in the same virtual server execute in the same
subinterpreter, even if they are in different directories.

For example, assume there is a
:file:`/directory/subdirectory`. :file:`/directory` has an
``.htaccess`` file with a ``PythonHandler`` directive.
:file:`/directory/subdirectory` doesn't have an ``.htaccess``. By
default, scripts in :file:`/directory` and
:file:`/directory/subdirectory` would execute in the same interpreter
assuming both directories are accessed via the same virtual
server. With ``PythonInterpPerDirectory``, there would be two
different interpreters, one for each directory.

.. note::

   In early phases of the request prior to the URI translation
   (PostReadRequestHandler and TransHandler) the path is not yet known
   because the URI has not been translated. During those phases and
   with PythonInterpPerDirectory on, all python code gets executed in
   the main interpreter. This may not be exactly what you want, but
   unfortunately there is no way around this.


.. seealso::

   :ref:`pyapi-interps`
       for more information


.. _dir-other-ipdv:

PythonInterpPerDirective
------------------------

.. index::
   single: PythonInterpPerDirective

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonInterpPerDirective {On, Off} |br|
`Default: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Default>`_ PythonInterpPerDirective Off |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Instructs mod_python to name subinterpreters using the directory in
which the Python*Handler directive currently in effect was
encountered.

For example, assume there is a
:file:`/directory/subdirectory`. :file:`/directory` has an ``.htaccess``
file with a ``PythonHandler`` directive.  :file:`/directory/subdirectory`
has another :file:`.htaccess` file with another ``PythonHandler``. By
default, scripts in :file:`/directory` and
:file:`/directory/subdirectory` would execute in the same interpreter
assuming both directories are in the same virtual server. With
``PythonInterpPerDirective``, there would be two different interpreters,
one for each directive.

.. seealso::

   :ref:`pyapi-interps`
       for more information

.. _dir-other-pi:

PythonInterpreter
-----------------

.. index::
   single: PythonInterpreter

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonInterpreter *name* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Forces mod_python to use interpreter named *name*, overriding the
default behaviour or behaviour dictated by a :ref:`dir-other-ipd` or
:ref:`dir-other-ipdv` direcive.

This directive can be used to force execution that would normally
occur in different subinterpreters to run in the same one. When
specified in the DocumentRoot, it forces the whole server to run in one
subinterpreter.

.. seealso::

   :ref:`pyapi-interps`
       for more information

.. _dir-other-phm:

PythonHandlerModule
-------------------

.. index::
   single: PythonHandlerModule

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonHandlerModule *module* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


PythonHandlerModule can be used an alternative to Python*Handler
directives. The module specified in this handler will be searched for
existence of functions matching the default handler function names,
and if a function is found, it will be executed.

For example, instead of::

   PythonAuthenHandler mymodule
   PythonHandler mymodule
   PythonLogHandler mymodule


one can simply use::

   PythonHandlerModule mymodule


.. _dir-other-par:

PythonAutoReload
----------------

.. index::
   single: PythonAutoReload

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonAutoReload {On, Off} |br|
`Default: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Default>`_ PythonAutoReload On |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


If set to Off, instructs mod_python not to check the modification date
of the module file.

By default, mod_python checks the time-stamp of the file and reloads
the module if the module's file modification date is later than the
last import or reload. This way changed modules get automatically
reimported, eliminating the need to restart the server for every
change.

Disabling autoreload is useful in production environment where the
modules do not change; it will save some processing time and give a
small performance gain.

.. _dir-other-pomz:

PythonOptimize
--------------

.. index::
   single: PythonOptimize

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonOptimize {On, Off} |br|
`Default: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Default>`_ PythonOptimize Off |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Enables Python optimization. Same as the Python ``-O`` option.

.. _dir-other-po:

PythonOption
------------

.. index::
   single: PythonOption

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonOption key [value] |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


Assigns a key value pair to a table that can be later retrieved by the
:meth:`request.get_options` function. This is useful to pass information
between the apache configuration files (:file:`httpd.conf`,
:file:`.htaccess`, etc) and the Python programs. If the value is omitted or empty (``""``),
then the key is removed from the local configuration.

Reserved PythonOption Keywords
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Some ``PythonOption`` keywords are used for configuring various aspects of
mod_python. Any keyword starting with mod_python.\* should be considered
as reserved for internal mod_python use.

Users are encouraged to use their own namespace qualifiers when creating
add-on modules, and not pollute the global namespace.

The following PythonOption keys are currently used by mod_python.

| mod_python.mutex_directory
| mod_python.mutex_locks
| mod_python.psp.cache_database_filename
| mod_python.session.session_type
| mod_python.session.cookie_name
| mod_python.session.application_domain
| mod_python.session.application_path
| mod_python.session.database_directory
| mod_python.dbm_session.database_filename
| mod_python.dbm_session.database_directory
| mod_python.file_session.enable_fast_cleanup
| mod_python.file_session.verify_session_timeout
| mod_python.file_session.cleanup_grace_period
| mod_python.file_session.cleanup_time_limit
| mod_python.file_session.database_directory
| mod_python.wsgi.application
| mod_python.wsgi.base_uri

| session *Deprecated in 3.3, use mod_python.session.session_type*
| ApplicationPath *Deprecated in 3.3, use mod_python.session.application_path*
| session_cookie_name *Deprecated in 3.3, use mod_python.session.cookie_name*
| session_directory *Deprecated in 3.3, use mod_python.session.database_directory*
| session_dbm *Deprecated in 3.3, use mod_python.dbm_session.database_filename*
| session_cleanup_time_limit *Deprecated in 3.3, use mod_python.file_session.cleanup_time_limit*
| session_fast_cleanup *Deprecated in 3.3, use mod_python.file_session.enable_fast_cleanup*
| session_grace_period *Deprecated in 3.3, use mod_python.file_session.cleanup_grace_period*
| session_verify_cleanup *Deprecated in 3.3, use mod_python.file_session.cleanup_session_timeout*
| PSPDbmCache *Deprecated in 3.3, use mod_python.psp.cache_database_filename*


.. _dir-other-pp:

PythonPath
----------

.. index::
   single: PythonPath

`Syntax: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Syntax>`_ PythonPath *path* |br|
`Context: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Context>`_ server config, virtual host, directory, htaccess |br|
`Override: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Override>`_ not None |br|
`Module: <http://httpd.apache.org/docs-2.4/mod/directive-dict.html#Module>`_ mod_python.c |br|


PythonPath directive sets the PythonPath. The path must be specified
in Python list notation, e.g.::

   PythonPath "['/usr/local/lib/python2.0', '/usr/local/lib/site_python', '/some/other/place']"

The path specified in this directive will replace the path, not add to
it. However, because the value of the directive is evaled, to append a
directory to the path, one can specify something like::

   PythonPath "sys.path+['/mydir']"

Mod_python tries to minimize the number of evals associated with the
PythonPath directive because evals are slow and can negatively impact
performance, especially when the directive is specified in an
:file:`.htaccess` file which gets parsed at every hit. Mod_python will
remember the arguments to the PythonPath directive in the un-evaled
form, and before evaling the value it will compare it to the
remembered value. If the value is the same, no action is
taken. Because of this, you should not rely on the directive as a way
to restore the pythonpath to some value if your code changes it.

When multiple PythonPath directives are specified, the effect is not
cumulative, last directive will override all previous ones.

.. note::

   This directive should not be used as a security measure since the
   Python path is easily manipulated from within the scripts.