Opened 5 years ago

Closed 5 years ago

Last modified 4 years ago

#14384 closed (fixed)

Installation documentation should avoid sys.path.append

Reported by: monokrome Owned by: wogan
Component: Documentation Version: 1.2
Severity: Keywords: documentation apache mod_wsgi
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Using Apache's mod_wsgi implementation (and I'm sure some others), there are cases where sys.path.append will add redundant items to the system path. The mod_wsgi documentation requests that, instead, developers use the following in order to avoid these redundancies:

import sys
path = '/usr/local/wsgi/modules'
if path not in sys.path:
    sys.path.append(path)

More information is available here: WSGIReloadMechanism

Attachments (1)

14384.patch (622 bytes) - added by wogan 5 years ago.

Download all attachments as: .zip

Change History (6)

Changed 5 years ago by wogan

comment:1 Changed 5 years ago by wogan

  • Has patch set
  • milestone set to 1.3
  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to wogan
  • Patch needs improvement unset
  • Status changed from new to assigned
  • Triage Stage changed from Unreviewed to Accepted

Agreed, the documentation should follow mod_wsgi best practices here.

The patch just contains the appropriate changes to the WSGI application without explanation. I'm not entirely sure whether a footnote is required or not.

comment:2 Changed 5 years ago by timo

  • Triage Stage changed from Accepted to Ready for checkin

comment:3 Changed 5 years ago by russellm

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [14016]) Fixed #14384 -- Updated mod_wsgi docs to match documented best practice. Thanks to monokrome for the report and wogan for the patch.

comment:4 Changed 5 years ago by russellm

(In [14024]) [1.2.X] Fixed #14384 -- Updated mod_wsgi docs to match documented best practice. Thanks to monokrome for the report and wogan for the patch.

Backport of r14016 from trunk.

comment:5 Changed 4 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

Note: See TracTickets for help on using tickets.
Back to Top