Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : wsgiref.html

<!DOCTYPE html>

<title>20.4. wsgiref — WSGI Utilities and Reference Implementation &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="20.5. urllib — Open arbitrary resources by URL" href="urllib.html" />
 <link rel="prev" title="20.3. cgitb — Traceback manager for CGI scripts" href="cgitb.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/wsgiref.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/wsgiref.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="urllib.html" title="20.5. urllib — Open arbitrary resources by URL"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="cgitb.html" title="20.3. cgitb — Traceback manager for CGI scripts"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">20. Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">20.4. <code class="xref py py-mod docutils literal notranslate">wsgiref</code> — WSGI Utilities and Reference Implementation</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-wsgiref">
<h1>20.4. <a class="reference internal" href="#module-wsgiref" title="wsgiref: WSGI Utilities and Reference Implementation."><code class="xref py py-mod docutils literal notranslate">wsgiref</code></a> — WSGI Utilities and Reference Implementation<a class="headerlink" href="#module-wsgiref" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
New in version 2.5.
</div>
The Web Server Gateway Interface (WSGI) is a standard interface between web
server software and web applications written in Python. Having a standard
interface makes it easy to use an application that supports WSGI with a number
of different web servers.
Only authors of web servers and programming frameworks need to know every detail
and corner case of the WSGI design. You don’t need to understand every detail
of WSGI just to install a WSGI application or to write a web application using
an existing framework.
<a class="reference internal" href="#module-wsgiref" title="wsgiref: WSGI Utilities and Reference Implementation."><code class="xref py py-mod docutils literal notranslate">wsgiref</code></a> is a reference implementation of the WSGI specification that can
be used to add WSGI support to a web server or framework. It provides utilities
for manipulating WSGI environment variables and response headers, base classes
for implementing WSGI servers, a demo HTTP server that serves WSGI applications,
and a validation tool that checks WSGI servers and applications for conformance
to the WSGI specification (<a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>).
See <a class="reference external" href="https://wsgi.readthedocs.org/">https://wsgi.readthedocs.org/</a> for more information about WSGI, and links to
tutorials and other resources.
<section id="module-wsgiref.util">
<h2>20.4.1. <a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate">wsgiref.util</code></a> – WSGI environment utilities<a class="headerlink" href="#module-wsgiref.util" title="Permalink to this headline">¶</a></h2>
This module provides a variety of utility functions for working with WSGI
environments. A WSGI environment is a dictionary containing HTTP request
variables as described in <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>. All of the functions taking an environ
parameter expect a WSGI-compliant dictionary to be supplied; please see
<a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a> for a detailed specification.
<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.util.guess_scheme">
wsgiref.util.guess_scheme(environ)<a class="headerlink" href="#wsgiref.util.guess_scheme" title="Permalink to this definition">¶</a></dt>
<dd>Return a guess for whether <code class="docutils literal notranslate">wsgi.url_scheme</code> should be “http” or “https”, by
checking for a <code class="docutils literal notranslate">HTTPS</code> environment variable in the environ dictionary. The
return value is a string.
This function is useful when creating a gateway that wraps CGI or a CGI-like
protocol such as FastCGI. Typically, servers providing such protocols will
include a <code class="docutils literal notranslate">HTTPS</code> variable with a value of “1” “yes”, or “on” when a request
is received via SSL. So, this function returns “https” if such a value is
found, and “http” otherwise.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.util.request_uri">
wsgiref.util.request_uri(environ, include_query=1)<a class="headerlink" href="#wsgiref.util.request_uri" title="Permalink to this definition">¶</a></dt>
<dd>Return the full request URI, optionally including the query string, using the
algorithm found in the “URL Reconstruction” section of <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>. If
include_query is false, the query string is not included in the resulting URI.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.util.application_uri">
wsgiref.util.application_uri(environ)<a class="headerlink" href="#wsgiref.util.application_uri" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <a class="reference internal" href="#wsgiref.util.request_uri" title="wsgiref.util.request_uri"><code class="xref py py-func docutils literal notranslate">request_uri()</code></a>, except that the <code class="docutils literal notranslate">PATH_INFO</code> and
<code class="docutils literal notranslate">QUERY_STRING</code> variables are ignored. The result is the base URI of the
application object addressed by the request.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.util.shift_path_info">
wsgiref.util.shift_path_info(environ)<a class="headerlink" href="#wsgiref.util.shift_path_info" title="Permalink to this definition">¶</a></dt>
<dd>Shift a single name from <code class="docutils literal notranslate">PATH_INFO</code> to <code class="docutils literal notranslate">SCRIPT_NAME</code> and return the name.
The environ dictionary is modified in-place; use a copy if you need to keep
the original <code class="docutils literal notranslate">PATH_INFO</code> or <code class="docutils literal notranslate">SCRIPT_NAME</code> intact.
If there are no remaining path segments in <code class="docutils literal notranslate">PATH_INFO</code>, <code class="docutils literal notranslate">None</code> is returned.
Typically, this routine is used to process each portion of a request URI path,
for example to treat the path as a series of dictionary keys. This routine
modifies the passed-in environment to make it suitable for invoking another WSGI
application that is located at the target URI. For example, if there is a WSGI
application at <code class="docutils literal notranslate">/foo</code>, and the request URI path is <code class="docutils literal notranslate">/foo/bar/baz</code>, and the
WSGI application at <code class="docutils literal notranslate">/foo</code> calls <a class="reference internal" href="#wsgiref.util.shift_path_info" title="wsgiref.util.shift_path_info"><code class="xref py py-func docutils literal notranslate">shift_path_info()</code></a>, it will receive the
string “bar”, and the environment will be updated to be suitable for passing to
a WSGI application at <code class="docutils literal notranslate">/foo/bar</code>. That is, <code class="docutils literal notranslate">SCRIPT_NAME</code> will change from
<code class="docutils literal notranslate">/foo</code> to <code class="docutils literal notranslate">/foo/bar</code>, and <code class="docutils literal notranslate">PATH_INFO</code> will change from <code class="docutils literal notranslate">/bar/baz</code> to
<code class="docutils literal notranslate">/baz</code>.
When <code class="docutils literal notranslate">PATH_INFO</code> is just a “/”, this routine returns an empty string and
appends a trailing slash to <code class="docutils literal notranslate">SCRIPT_NAME</code>, even though empty path segments are
normally ignored, and <code class="docutils literal notranslate">SCRIPT_NAME</code> doesn’t normally end in a slash. This is
intentional behavior, to ensure that an application can tell the difference
between URIs ending in <code class="docutils literal notranslate">/x</code> from ones ending in <code class="docutils literal notranslate">/x/</code> when using this
routine to do object traversal.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.util.setup_testing_defaults">
wsgiref.util.setup_testing_defaults(environ)<a class="headerlink" href="#wsgiref.util.setup_testing_defaults" title="Permalink to this definition">¶</a></dt>
<dd>Update environ with trivial defaults for testing purposes.
This routine adds various parameters required for WSGI, including <code class="docutils literal notranslate">HTTP_HOST</code>,
<code class="docutils literal notranslate">SERVER_NAME</code>, <code class="docutils literal notranslate">SERVER_PORT</code>, <code class="docutils literal notranslate">REQUEST_METHOD</code>, <code class="docutils literal notranslate">SCRIPT_NAME</code>,
<code class="docutils literal notranslate">PATH_INFO</code>, and all of the <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>-defined <code class="docutils literal notranslate">wsgi.*</code> variables. It
only supplies default values, and does not replace any existing settings for
these variables.
This routine is intended to make it easier for unit tests of WSGI servers and
applications to set up dummy environments. It should NOT be used by actual WSGI
servers or applications, since the data is fake!
Example usage:
<div class="highlight-default notranslate"><div class="highlight"><pre>from wsgiref.util import setup_testing_defaults
from wsgiref.simple_server import make_server

# A relatively simple WSGI application. It&#39;s going to print out the
# environment dictionary after being updated by setup_testing_defaults
def simple_app(environ, start_response):
 setup_testing_defaults(environ)

status = &#39;200 OK&#39;
 headers = [(&#39;Content-type&#39;, &#39;text/plain&#39;)]

start_response(status, headers)

ret = [&quot;%s: %s\n&quot; % (key, value)
 for key, value in environ.iteritems()]
 return ret

httpd = make_server(&#39;&#39;, 8000, simple_app)
print &quot;Serving on port 8000...&quot;
httpd.serve_forever()
</pre></div>
</div>
</dd></dl>

In addition to the environment functions above, the <a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate">wsgiref.util</code></a> module
also provides these miscellaneous utilities:
<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.util.is_hop_by_hop">
wsgiref.util.is_hop_by_hop(header_name)<a class="headerlink" href="#wsgiref.util.is_hop_by_hop" title="Permalink to this definition">¶</a></dt>
<dd>Return true if ‘header_name’ is an HTTP/1.1 “Hop-by-Hop” header, as defined by
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc2616.html">RFC 2616</a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="wsgiref.util.FileWrapper">
class wsgiref.util.FileWrapper(filelike, blksize=8192)<a class="headerlink" href="#wsgiref.util.FileWrapper" title="Permalink to this definition">¶</a></dt>
<dd>A wrapper to convert a file-like object to an <a class="reference internal" href="../glossary.html#term-iterator">iterator</a>. The resulting objects
support both <code class="xref py py-meth docutils literal notranslate">__getitem__()</code> and <code class="xref py py-meth docutils literal notranslate">__iter__()</code> iteration styles, for
compatibility with Python 2.1 and Jython. As the object is iterated over, the
optional blksize parameter will be repeatedly passed to the filelike
object’s <code class="xref py py-meth docutils literal notranslate">read()</code> method to obtain strings to yield. When <code class="xref py py-meth docutils literal notranslate">read()</code>
returns an empty string, iteration is ended and is not resumable.
If filelike has a <code class="xref py py-meth docutils literal notranslate">close()</code> method, the returned object will also have a
<code class="xref py py-meth docutils literal notranslate">close()</code> method, and it will invoke the filelike object’s <code class="xref py py-meth docutils literal notranslate">close()</code>
method when called.
Example usage:
<div class="highlight-default notranslate"><div class="highlight"><pre>from StringIO import StringIO
from wsgiref.util import FileWrapper

# We&#39;re using a StringIO-buffer for as the file-like object
filelike = StringIO(&quot;This is an example file-like object&quot;*10)
wrapper = FileWrapper(filelike, blksize=5)

for chunk in wrapper:
 print chunk
</pre></div>
</div>
</dd></dl>

</section>
<section id="module-wsgiref.headers">
<h2>20.4.2. <a class="reference internal" href="#module-wsgiref.headers" title="wsgiref.headers: WSGI response header tools."><code class="xref py py-mod docutils literal notranslate">wsgiref.headers</code></a> – WSGI response header tools<a class="headerlink" href="#module-wsgiref.headers" title="Permalink to this headline">¶</a></h2>
This module provides a single class, <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate">Headers</code></a>, for convenient
manipulation of WSGI response headers using a mapping-like interface.
<dl class="py class">
<dt class="sig sig-object py" id="wsgiref.headers.Headers">
class wsgiref.headers.Headers(headers)<a class="headerlink" href="#wsgiref.headers.Headers" title="Permalink to this definition">¶</a></dt>
<dd>Create a mapping-like object wrapping headers, which must be a list of header
name/value tuples as described in <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>. Any changes made to the new
<a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate">Headers</code></a> object will directly update the headers list it was created
with.
<a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate">Headers</code></a> objects support typical mapping operations including
<code class="xref py py-meth docutils literal notranslate">__getitem__()</code>, <code class="xref py py-meth docutils literal notranslate">get()</code>, <code class="xref py py-meth docutils literal notranslate">__setitem__()</code>, <code class="xref py py-meth docutils literal notranslate">setdefault()</code>,
<code class="xref py py-meth docutils literal notranslate">__delitem__()</code>, <code class="xref py py-meth docutils literal notranslate">__contains__()</code> and <code class="xref py py-meth docutils literal notranslate">has_key()</code>. For each of
these methods, the key is the header name (treated case-insensitively), and the
value is the first value associated with that header name. Setting a header
deletes any existing values for that header, then adds a new value at the end of
the wrapped header list. Headers’ existing order is generally maintained, with
new headers added to the end of the wrapped list.
Unlike a dictionary, <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate">Headers</code></a> objects do not raise an error when you try
to get or delete a key that isn’t in the wrapped header list. Getting a
nonexistent header just returns <code class="docutils literal notranslate">None</code>, and deleting a nonexistent header does
nothing.
<a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate">Headers</code></a> objects also support <code class="xref py py-meth docutils literal notranslate">keys()</code>, <code class="xref py py-meth docutils literal notranslate">values()</code>, and
<code class="xref py py-meth docutils literal notranslate">items()</code> methods. The lists returned by <code class="xref py py-meth docutils literal notranslate">keys()</code> and <code class="xref py py-meth docutils literal notranslate">items()</code> can
include the same key more than once if there is a multi-valued header. The
<code class="docutils literal notranslate">len()</code> of a <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate">Headers</code></a> object is the same as the length of its
<code class="xref py py-meth docutils literal notranslate">items()</code>, which is the same as the length of the wrapped header list. In
fact, the <code class="xref py py-meth docutils literal notranslate">items()</code> method just returns a copy of the wrapped header list.
Calling <code class="docutils literal notranslate">str()</code> on a <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate">Headers</code></a> object returns a formatted string
suitable for transmission as HTTP response headers. Each header is placed on a
line with its value, separated by a colon and a space. Each line is terminated
by a carriage return and line feed, and the string is terminated with a blank
line.
In addition to their mapping interface and formatting features, <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate">Headers</code></a>
objects also have the following methods for querying and adding multi-valued
headers, and for adding headers with MIME parameters:
<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.headers.Headers.get_all">
get_all(name)<a class="headerlink" href="#wsgiref.headers.Headers.get_all" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of all the values for the named header.
The returned list will be sorted in the order they appeared in the original
header list or were added to this instance, and may contain duplicates. Any
fields deleted and re-inserted are always appended to the header list. If no
fields exist with the given name, returns an empty list.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.headers.Headers.add_header">
add_header(name, value, **_params)<a class="headerlink" href="#wsgiref.headers.Headers.add_header" title="Permalink to this definition">¶</a></dt>
<dd>Add a (possibly multi-valued) header, with optional MIME parameters specified
via keyword arguments.
name is the header field to add. Keyword arguments can be used to set MIME
parameters for the header field. Each parameter must be a string or <code class="docutils literal notranslate">None</code>.
Underscores in parameter names are converted to dashes, since dashes are illegal
in Python identifiers, but many MIME parameter names include dashes. If the
parameter value is a string, it is added to the header value parameters in the
form <code class="docutils literal notranslate">name=&quot;value&quot;</code>. If it is <code class="docutils literal notranslate">None</code>, only the parameter name is added.
(This is used for MIME parameters without a value.) Example usage:
<div class="highlight-default notranslate"><div class="highlight"><pre>h.add_header(&#39;content-disposition&#39;, &#39;attachment&#39;, filename=&#39;bud.gif&#39;)
</pre></div>
</div>
The above will add a header that looks like this:
<div class="highlight-default notranslate"><div class="highlight"><pre>Content-Disposition: attachment; filename=&quot;bud.gif&quot;
</pre></div>
</div>
</dd></dl>

</dd></dl>

</section>
<section id="module-wsgiref.simple_server">
<h2>20.4.3. <a class="reference internal" href="#module-wsgiref.simple_server" title="wsgiref.simple_server: A simple WSGI HTTP server."><code class="xref py py-mod docutils literal notranslate">wsgiref.simple_server</code></a> – a simple WSGI HTTP server<a class="headerlink" href="#module-wsgiref.simple_server" title="Permalink to this headline">¶</a></h2>
This module implements a simple HTTP server (based on <a class="reference internal" href="basehttpserver.html#module-BaseHTTPServer" title="BaseHTTPServer: Basic HTTP server (base class for SimpleHTTPServer and CGIHTTPServer)."><code class="xref py py-mod docutils literal notranslate">BaseHTTPServer</code></a>)
that serves WSGI applications. Each server instance serves a single WSGI
application on a given host and port. If you want to serve multiple
applications on a single host and port, you should create a WSGI application
that parses <code class="docutils literal notranslate">PATH_INFO</code> to select which application to invoke for each
request. (E.g., using the <code class="xref py py-func docutils literal notranslate">shift_path_info()</code> function from
<a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate">wsgiref.util</code></a>.)
<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.simple_server.make_server">
wsgiref.simple_server.make_server(host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler)<a class="headerlink" href="#wsgiref.simple_server.make_server" title="Permalink to this definition">¶</a></dt>
<dd>Create a new WSGI server listening on host and port, accepting connections
for app. The return value is an instance of the supplied server_class, and
will process requests using the specified handler_class. app must be a WSGI
application object, as defined by <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>.
Example usage:
<div class="highlight-default notranslate"><div class="highlight"><pre>from wsgiref.simple_server import make_server, demo_app

httpd = make_server(&#39;&#39;, 8000, demo_app)
print &quot;Serving HTTP on port 8000...&quot;

# Respond to requests until process is killed
httpd.serve_forever()

# Alternative: serve one request, then exit
httpd.handle_request()
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.simple_server.demo_app">
wsgiref.simple_server.demo_app(environ, start_response)<a class="headerlink" href="#wsgiref.simple_server.demo_app" title="Permalink to this definition">¶</a></dt>
<dd>This function is a small but complete WSGI application that returns a text page
containing the message “Hello world!” and a list of the key/value pairs provided
in the environ parameter. It’s useful for verifying that a WSGI server (such
as <a class="reference internal" href="#module-wsgiref.simple_server" title="wsgiref.simple_server: A simple WSGI HTTP server."><code class="xref py py-mod docutils literal notranslate">wsgiref.simple_server</code></a>) is able to run a simple WSGI application
correctly.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="wsgiref.simple_server.WSGIServer">
class wsgiref.simple_server.WSGIServer(server_address, RequestHandlerClass)<a class="headerlink" href="#wsgiref.simple_server.WSGIServer" title="Permalink to this definition">¶</a></dt>
<dd>Create a <a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate">WSGIServer</code></a> instance. server_address should be a
<code class="docutils literal notranslate">(host,port)</code> tuple, and RequestHandlerClass should be the subclass of
<a class="reference internal" href="basehttpserver.html#BaseHTTPServer.BaseHTTPRequestHandler" title="BaseHTTPServer.BaseHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate">BaseHTTPServer.BaseHTTPRequestHandler</code></a> that will be used to process
requests.
You do not normally need to call this constructor, as the <a class="reference internal" href="#wsgiref.simple_server.make_server" title="wsgiref.simple_server.make_server"><code class="xref py py-func docutils literal notranslate">make_server()</code></a>
function can handle all the details for you.
<a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate">WSGIServer</code></a> is a subclass of <a class="reference internal" href="basehttpserver.html#BaseHTTPServer.HTTPServer" title="BaseHTTPServer.HTTPServer"><code class="xref py py-class docutils literal notranslate">BaseHTTPServer.HTTPServer</code></a>, so all
of its methods (such as <code class="xref py py-meth docutils literal notranslate">serve_forever()</code> and <code class="xref py py-meth docutils literal notranslate">handle_request()</code>) are
available. <a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate">WSGIServer</code></a> also provides these WSGI-specific methods:
<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.simple_server.WSGIServer.set_app">
set_app(application)<a class="headerlink" href="#wsgiref.simple_server.WSGIServer.set_app" title="Permalink to this definition">¶</a></dt>
<dd>Sets the callable application as the WSGI application that will receive
requests.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.simple_server.WSGIServer.get_app">
get_app()<a class="headerlink" href="#wsgiref.simple_server.WSGIServer.get_app" title="Permalink to this definition">¶</a></dt>
<dd>Returns the currently-set application callable.
</dd></dl>

Normally, however, you do not need to use these additional methods, as
<a class="reference internal" href="#wsgiref.simple_server.WSGIServer.set_app" title="wsgiref.simple_server.WSGIServer.set_app"><code class="xref py py-meth docutils literal notranslate">set_app()</code></a> is normally called by <a class="reference internal" href="#wsgiref.simple_server.make_server" title="wsgiref.simple_server.make_server"><code class="xref py py-func docutils literal notranslate">make_server()</code></a>, and the
<a class="reference internal" href="#wsgiref.simple_server.WSGIServer.get_app" title="wsgiref.simple_server.WSGIServer.get_app"><code class="xref py py-meth docutils literal notranslate">get_app()</code></a> exists mainly for the benefit of request handler instances.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="wsgiref.simple_server.WSGIRequestHandler">
class wsgiref.simple_server.WSGIRequestHandler(request, client_address, server)<a class="headerlink" href="#wsgiref.simple_server.WSGIRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>Create an HTTP handler for the given request (i.e. a socket), client_address
(a <code class="docutils literal notranslate">(host,port)</code> tuple), and server (<a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate">WSGIServer</code></a> instance).
You do not need to create instances of this class directly; they are
automatically created as needed by <a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate">WSGIServer</code></a> objects. You can,
however, subclass this class and supply it as a handler_class to the
<a class="reference internal" href="#wsgiref.simple_server.make_server" title="wsgiref.simple_server.make_server"><code class="xref py py-func docutils literal notranslate">make_server()</code></a> function. Some possibly relevant methods for overriding in
subclasses:
<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.simple_server.WSGIRequestHandler.get_environ">
get_environ()<a class="headerlink" href="#wsgiref.simple_server.WSGIRequestHandler.get_environ" title="Permalink to this definition">¶</a></dt>
<dd>Returns a dictionary containing the WSGI environment for a request. The default
implementation copies the contents of the <a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate">WSGIServer</code></a> object’s
<code class="xref py py-attr docutils literal notranslate">base_environ</code> dictionary attribute and then adds various headers derived
from the HTTP request. Each call to this method should return a new dictionary
containing all of the relevant CGI environment variables as specified in
<a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.simple_server.WSGIRequestHandler.get_stderr">
get_stderr()<a class="headerlink" href="#wsgiref.simple_server.WSGIRequestHandler.get_stderr" title="Permalink to this definition">¶</a></dt>
<dd>Return the object that should be used as the <code class="docutils literal notranslate">wsgi.errors</code> stream. The default
implementation just returns <code class="docutils literal notranslate">sys.stderr</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.simple_server.WSGIRequestHandler.handle">
handle()<a class="headerlink" href="#wsgiref.simple_server.WSGIRequestHandler.handle" title="Permalink to this definition">¶</a></dt>
<dd>Process the HTTP request. The default implementation creates a handler instance
using a <a class="reference internal" href="#module-wsgiref.handlers" title="wsgiref.handlers: WSGI server/gateway base classes."><code class="xref py py-mod docutils literal notranslate">wsgiref.handlers</code></a> class to implement the actual WSGI application
interface.
</dd></dl>

</dd></dl>

</section>
<section id="module-wsgiref.validate">
<h2>20.4.4. <a class="reference internal" href="#module-wsgiref.validate" title="wsgiref.validate: WSGI conformance checker."><code class="xref py py-mod docutils literal notranslate">wsgiref.validate</code></a> — WSGI conformance checker<a class="headerlink" href="#module-wsgiref.validate" title="Permalink to this headline">¶</a></h2>
When creating new WSGI application objects, frameworks, servers, or middleware,
it can be useful to validate the new code’s conformance using
<a class="reference internal" href="#module-wsgiref.validate" title="wsgiref.validate: WSGI conformance checker."><code class="xref py py-mod docutils literal notranslate">wsgiref.validate</code></a>. This module provides a function that creates WSGI
application objects that validate communications between a WSGI server or
gateway and a WSGI application object, to check both sides for protocol
conformance.
Note that this utility does not guarantee complete <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a> compliance; an
absence of errors from this module does not necessarily mean that errors do not
exist. However, if this module does produce an error, then it is virtually
certain that either the server or application is not 100% compliant.
This module is based on the <code class="xref py py-mod docutils literal notranslate">paste.lint</code> module from Ian Bicking’s “Python
Paste” library.
<dl class="py function">
<dt class="sig sig-object py" id="wsgiref.validate.validator">
wsgiref.validate.validator(application)<a class="headerlink" href="#wsgiref.validate.validator" title="Permalink to this definition">¶</a></dt>
<dd>Wrap application and return a new WSGI application object. The returned
application will forward all requests to the original application, and will
check that both the application and the server invoking it are conforming to
the WSGI specification and to RFC 2616.
Any detected nonconformance results in an <code class="xref py py-exc docutils literal notranslate">AssertionError</code> being raised;
note, however, that how these errors are handled is server-dependent. For
example, <a class="reference internal" href="#module-wsgiref.simple_server" title="wsgiref.simple_server: A simple WSGI HTTP server."><code class="xref py py-mod docutils literal notranslate">wsgiref.simple_server</code></a> and other servers based on
<a class="reference internal" href="#module-wsgiref.handlers" title="wsgiref.handlers: WSGI server/gateway base classes."><code class="xref py py-mod docutils literal notranslate">wsgiref.handlers</code></a> (that don’t override the error handling methods to do
something else) will simply output a message that an error has occurred, and
dump the traceback to <code class="docutils literal notranslate">sys.stderr</code> or some other error stream.
This wrapper may also generate output using the <a class="reference internal" href="warnings.html#module-warnings" title="warnings: Issue warning messages and control their disposition."><code class="xref py py-mod docutils literal notranslate">warnings</code></a> module to
indicate behaviors that are questionable but which may not actually be
prohibited by <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>. Unless they are suppressed using Python command-line
options or the <a class="reference internal" href="warnings.html#module-warnings" title="warnings: Issue warning messages and control their disposition."><code class="xref py py-mod docutils literal notranslate">warnings</code></a> API, any such warnings will be written to
<code class="docutils literal notranslate">sys.stderr</code> (not <code class="docutils literal notranslate">wsgi.errors</code>, unless they happen to be the same
object).
Example usage:
<div class="highlight-default notranslate"><div class="highlight"><pre>from wsgiref.validate import validator
from wsgiref.simple_server import make_server

# Our callable object which is intentionally not compliant to the
# standard, so the validator is going to break
def simple_app(environ, start_response):
 status = &#39;200 OK&#39; # HTTP Status
 headers = [(&#39;Content-type&#39;, &#39;text/plain&#39;)] # HTTP Headers
 start_response(status, headers)

# This is going to break because we need to return a list, and
 # the validator is going to inform us
 return &quot;Hello World&quot;

# This is the application wrapped in a validator
validator_app = validator(simple_app)

httpd = make_server(&#39;&#39;, 8000, validator_app)
print &quot;Listening on port 8000....&quot;
httpd.serve_forever()
</pre></div>
</div>
</dd></dl>

</section>
<section id="module-wsgiref.handlers">
<h2>20.4.5. <a class="reference internal" href="#module-wsgiref.handlers" title="wsgiref.handlers: WSGI server/gateway base classes."><code class="xref py py-mod docutils literal notranslate">wsgiref.handlers</code></a> – server/gateway base classes<a class="headerlink" href="#module-wsgiref.handlers" title="Permalink to this headline">¶</a></h2>
This module provides base handler classes for implementing WSGI servers and
gateways. These base classes handle most of the work of communicating with a
WSGI application, as long as they are given a CGI-like environment, along with
input, output, and error streams.
<dl class="py class">
<dt class="sig sig-object py" id="wsgiref.handlers.CGIHandler">
class wsgiref.handlers.CGIHandler<a class="headerlink" href="#wsgiref.handlers.CGIHandler" title="Permalink to this definition">¶</a></dt>
<dd>CGI-based invocation via <code class="docutils literal notranslate">sys.stdin</code>, <code class="docutils literal notranslate">sys.stdout</code>, <code class="docutils literal notranslate">sys.stderr</code> and
<code class="docutils literal notranslate">os.environ</code>. This is useful when you have a WSGI application and want to run
it as a CGI script. Simply invoke <code class="docutils literal notranslate">CGIHandler().run(app)</code>, where <code class="docutils literal notranslate">app</code> is
the WSGI application object you wish to invoke.
This class is a subclass of <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate">BaseCGIHandler</code></a> that sets <code class="docutils literal notranslate">wsgi.run_once</code>
to true, <code class="docutils literal notranslate">wsgi.multithread</code> to false, and <code class="docutils literal notranslate">wsgi.multiprocess</code> to true, and
always uses <a class="reference internal" href="sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> and <a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate">os</code></a> to obtain the necessary CGI streams and
environment.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseCGIHandler">
class wsgiref.handlers.BaseCGIHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False)<a class="headerlink" href="#wsgiref.handlers.BaseCGIHandler" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate">CGIHandler</code></a>, but instead of using the <a class="reference internal" href="sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> and
<a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate">os</code></a> modules, the CGI environment and I/O streams are specified explicitly.
The multithread and multiprocess values are used to set the
<code class="docutils literal notranslate">wsgi.multithread</code> and <code class="docutils literal notranslate">wsgi.multiprocess</code> flags for any applications run by
the handler instance.
This class is a subclass of <a class="reference internal" href="#wsgiref.handlers.SimpleHandler" title="wsgiref.handlers.SimpleHandler"><code class="xref py py-class docutils literal notranslate">SimpleHandler</code></a> intended for use with
software other than HTTP “origin servers”. If you are writing a gateway
protocol implementation (such as CGI, FastCGI, SCGI, etc.) that uses a
<code class="docutils literal notranslate">Status:</code> header to send an HTTP status, you probably want to subclass this
instead of <a class="reference internal" href="#wsgiref.handlers.SimpleHandler" title="wsgiref.handlers.SimpleHandler"><code class="xref py py-class docutils literal notranslate">SimpleHandler</code></a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="wsgiref.handlers.SimpleHandler">
class wsgiref.handlers.SimpleHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False)<a class="headerlink" href="#wsgiref.handlers.SimpleHandler" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate">BaseCGIHandler</code></a>, but designed for use with HTTP origin
servers. If you are writing an HTTP server implementation, you will probably
want to subclass this instead of <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate">BaseCGIHandler</code></a>.
This class is a subclass of <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>. It overrides the
<code class="xref py py-meth docutils literal notranslate">__init__()</code>, <code class="xref py py-meth docutils literal notranslate">get_stdin()</code>, <code class="xref py py-meth docutils literal notranslate">get_stderr()</code>, <code class="xref py py-meth docutils literal notranslate">add_cgi_vars()</code>,
<code class="xref py py-meth docutils literal notranslate">_write()</code>, and <code class="xref py py-meth docutils literal notranslate">_flush()</code> methods to support explicitly setting the
environment and streams via the constructor. The supplied environment and
streams are stored in the <code class="xref py py-attr docutils literal notranslate">stdin</code>, <code class="xref py py-attr docutils literal notranslate">stdout</code>, <code class="xref py py-attr docutils literal notranslate">stderr</code>, and
<code class="xref py py-attr docutils literal notranslate">environ</code> attributes.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler">
class wsgiref.handlers.BaseHandler<a class="headerlink" href="#wsgiref.handlers.BaseHandler" title="Permalink to this definition">¶</a></dt>
<dd>This is an abstract base class for running WSGI applications. Each instance
will handle a single HTTP request, although in principle you could create a
subclass that was reusable for multiple requests.
<a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a> instances have only one method intended for external use:
<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.run">
run(app)<a class="headerlink" href="#wsgiref.handlers.BaseHandler.run" title="Permalink to this definition">¶</a></dt>
<dd>Run the specified WSGI application, app.
</dd></dl>

All of the other <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a> methods are invoked by this method in the
process of running the application, and thus exist primarily to allow
customizing the process.
The following methods MUST be overridden in a subclass:
<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler._write">
_write(data)<a class="headerlink" href="#wsgiref.handlers.BaseHandler._write" title="Permalink to this definition">¶</a></dt>
<dd>Buffer the string data for transmission to the client. It’s okay if this
method actually transmits the data; <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a> just separates write
and flush operations for greater efficiency when the underlying system actually
has such a distinction.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler._flush">
_flush()<a class="headerlink" href="#wsgiref.handlers.BaseHandler._flush" title="Permalink to this definition">¶</a></dt>
<dd>Force buffered data to be transmitted to the client. It’s okay if this method
is a no-op (i.e., if <a class="reference internal" href="#wsgiref.handlers.BaseHandler._write" title="wsgiref.handlers.BaseHandler._write"><code class="xref py py-meth docutils literal notranslate">_write()</code></a> actually sends the data).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.get_stdin">
get_stdin()<a class="headerlink" href="#wsgiref.handlers.BaseHandler.get_stdin" title="Permalink to this definition">¶</a></dt>
<dd>Return an input stream object suitable for use as the <code class="docutils literal notranslate">wsgi.input</code> of the
request currently being processed.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.get_stderr">
get_stderr()<a class="headerlink" href="#wsgiref.handlers.BaseHandler.get_stderr" title="Permalink to this definition">¶</a></dt>
<dd>Return an output stream object suitable for use as the <code class="docutils literal notranslate">wsgi.errors</code> of the
request currently being processed.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.add_cgi_vars">
add_cgi_vars()<a class="headerlink" href="#wsgiref.handlers.BaseHandler.add_cgi_vars" title="Permalink to this definition">¶</a></dt>
<dd>Insert CGI variables for the current request into the <code class="xref py py-attr docutils literal notranslate">environ</code> attribute.
</dd></dl>

Here are some other methods and attributes you may wish to override. This list
is only a summary, however, and does not include every method that can be
overridden. You should consult the docstrings and source code for additional
information before attempting to create a customized <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>
subclass.
Attributes and methods for customizing the WSGI environment:
<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.wsgi_multithread">
wsgi_multithread<a class="headerlink" href="#wsgiref.handlers.BaseHandler.wsgi_multithread" title="Permalink to this definition">¶</a></dt>
<dd>The value to be used for the <code class="docutils literal notranslate">wsgi.multithread</code> environment variable. It
defaults to true in <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but may have a different default (or
be set by the constructor) in the other subclasses.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.wsgi_multiprocess">
wsgi_multiprocess<a class="headerlink" href="#wsgiref.handlers.BaseHandler.wsgi_multiprocess" title="Permalink to this definition">¶</a></dt>
<dd>The value to be used for the <code class="docutils literal notranslate">wsgi.multiprocess</code> environment variable. It
defaults to true in <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but may have a different default (or
be set by the constructor) in the other subclasses.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.wsgi_run_once">
wsgi_run_once<a class="headerlink" href="#wsgiref.handlers.BaseHandler.wsgi_run_once" title="Permalink to this definition">¶</a></dt>
<dd>The value to be used for the <code class="docutils literal notranslate">wsgi.run_once</code> environment variable. It
defaults to false in <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate">CGIHandler</code></a> sets it to
true by default.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.os_environ">
os_environ<a class="headerlink" href="#wsgiref.handlers.BaseHandler.os_environ" title="Permalink to this definition">¶</a></dt>
<dd>The default environment variables to be included in every request’s WSGI
environment. By default, this is a copy of <code class="docutils literal notranslate">os.environ</code> at the time that
<a class="reference internal" href="#module-wsgiref.handlers" title="wsgiref.handlers: WSGI server/gateway base classes."><code class="xref py py-mod docutils literal notranslate">wsgiref.handlers</code></a> was imported, but subclasses can either create their own
at the class or instance level. Note that the dictionary should be considered
read-only, since the default value is shared between multiple classes and
instances.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.server_software">
server_software<a class="headerlink" href="#wsgiref.handlers.BaseHandler.server_software" title="Permalink to this definition">¶</a></dt>
<dd>If the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.origin_server" title="wsgiref.handlers.BaseHandler.origin_server"><code class="xref py py-attr docutils literal notranslate">origin_server</code></a> attribute is set, this attribute’s value is used to
set the default <code class="docutils literal notranslate">SERVER_SOFTWARE</code> WSGI environment variable, and also to set a
default <code class="docutils literal notranslate">Server:</code> header in HTTP responses. It is ignored for handlers (such
as <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate">BaseCGIHandler</code></a> and <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate">CGIHandler</code></a>) that are not HTTP origin
servers.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.get_scheme">
get_scheme()<a class="headerlink" href="#wsgiref.handlers.BaseHandler.get_scheme" title="Permalink to this definition">¶</a></dt>
<dd>Return the URL scheme being used for the current request. The default
implementation uses the <code class="xref py py-func docutils literal notranslate">guess_scheme()</code> function from <a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate">wsgiref.util</code></a>
to guess whether the scheme should be “http” or “https”, based on the current
request’s <code class="xref py py-attr docutils literal notranslate">environ</code> variables.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.setup_environ">
setup_environ()<a class="headerlink" href="#wsgiref.handlers.BaseHandler.setup_environ" title="Permalink to this definition">¶</a></dt>
<dd>Set the <code class="xref py py-attr docutils literal notranslate">environ</code> attribute to a fully-populated WSGI environment. The
default implementation uses all of the above methods and attributes, plus the
<a class="reference internal" href="#wsgiref.handlers.BaseHandler.get_stdin" title="wsgiref.handlers.BaseHandler.get_stdin"><code class="xref py py-meth docutils literal notranslate">get_stdin()</code></a>, <a class="reference internal" href="#wsgiref.handlers.BaseHandler.get_stderr" title="wsgiref.handlers.BaseHandler.get_stderr"><code class="xref py py-meth docutils literal notranslate">get_stderr()</code></a>, and <a class="reference internal" href="#wsgiref.handlers.BaseHandler.add_cgi_vars" title="wsgiref.handlers.BaseHandler.add_cgi_vars"><code class="xref py py-meth docutils literal notranslate">add_cgi_vars()</code></a> methods and the
<a class="reference internal" href="#wsgiref.handlers.BaseHandler.wsgi_file_wrapper" title="wsgiref.handlers.BaseHandler.wsgi_file_wrapper"><code class="xref py py-attr docutils literal notranslate">wsgi_file_wrapper</code></a> attribute. It also inserts a <code class="docutils literal notranslate">SERVER_SOFTWARE</code> key
if not present, as long as the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.origin_server" title="wsgiref.handlers.BaseHandler.origin_server"><code class="xref py py-attr docutils literal notranslate">origin_server</code></a> attribute is a true value
and the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.server_software" title="wsgiref.handlers.BaseHandler.server_software"><code class="xref py py-attr docutils literal notranslate">server_software</code></a> attribute is set.
</dd></dl>

Methods and attributes for customizing exception handling:
<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.log_exception">
log_exception(exc_info)<a class="headerlink" href="#wsgiref.handlers.BaseHandler.log_exception" title="Permalink to this definition">¶</a></dt>
<dd>Log the exc_info tuple in the server log. exc_info is a <code class="docutils literal notranslate">(type, value,
traceback)</code> tuple. The default implementation simply writes the traceback to
the request’s <code class="docutils literal notranslate">wsgi.errors</code> stream and flushes it. Subclasses can override
this method to change the format or retarget the output, mail the traceback to
an administrator, or whatever other action may be deemed suitable.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.traceback_limit">
traceback_limit<a class="headerlink" href="#wsgiref.handlers.BaseHandler.traceback_limit" title="Permalink to this definition">¶</a></dt>
<dd>The maximum number of frames to include in tracebacks output by the default
<a class="reference internal" href="#wsgiref.handlers.BaseHandler.log_exception" title="wsgiref.handlers.BaseHandler.log_exception"><code class="xref py py-meth docutils literal notranslate">log_exception()</code></a> method. If <code class="docutils literal notranslate">None</code>, all frames are included.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.error_output">
error_output(environ, start_response)<a class="headerlink" href="#wsgiref.handlers.BaseHandler.error_output" title="Permalink to this definition">¶</a></dt>
<dd>This method is a WSGI application to generate an error page for the user. It is
only invoked if an error occurs before headers are sent to the client.
This method can access the current error information using <code class="docutils literal notranslate">sys.exc_info()</code>,
and should pass that information to start_response when calling it (as
described in the “Error Handling” section of <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>).
The default implementation just uses the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.error_status" title="wsgiref.handlers.BaseHandler.error_status"><code class="xref py py-attr docutils literal notranslate">error_status</code></a>,
<a class="reference internal" href="#wsgiref.handlers.BaseHandler.error_headers" title="wsgiref.handlers.BaseHandler.error_headers"><code class="xref py py-attr docutils literal notranslate">error_headers</code></a>, and <a class="reference internal" href="#wsgiref.handlers.BaseHandler.error_body" title="wsgiref.handlers.BaseHandler.error_body"><code class="xref py py-attr docutils literal notranslate">error_body</code></a> attributes to generate an output
page. Subclasses can override this to produce more dynamic error output.
Note, however, that it’s not recommended from a security perspective to spit out
diagnostics to any old user; ideally, you should have to do something special to
enable diagnostic output, which is why the default implementation doesn’t
include any.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.error_status">
error_status<a class="headerlink" href="#wsgiref.handlers.BaseHandler.error_status" title="Permalink to this definition">¶</a></dt>
<dd>The HTTP status used for error responses. This should be a status string as
defined in <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>; it defaults to a 500 code and message.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.error_headers">
error_headers<a class="headerlink" href="#wsgiref.handlers.BaseHandler.error_headers" title="Permalink to this definition">¶</a></dt>
<dd>The HTTP headers used for error responses. This should be a list of WSGI
response headers (<code class="docutils literal notranslate">(name, value)</code> tuples), as described in <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>. The
default list just sets the content type to <code class="docutils literal notranslate">text/plain</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.error_body">
error_body<a class="headerlink" href="#wsgiref.handlers.BaseHandler.error_body" title="Permalink to this definition">¶</a></dt>
<dd>The error response body. This should be an HTTP response body string. It
defaults to the plain text, “A server error occurred. Please contact the
administrator.”
</dd></dl>

Methods and attributes for <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333">PEP 333</a>’s “Optional Platform-Specific File
Handling” feature:
<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.wsgi_file_wrapper">
wsgi_file_wrapper<a class="headerlink" href="#wsgiref.handlers.BaseHandler.wsgi_file_wrapper" title="Permalink to this definition">¶</a></dt>
<dd>A <code class="docutils literal notranslate">wsgi.file_wrapper</code> factory, or <code class="docutils literal notranslate">None</code>. The default value of this
attribute is the <code class="xref py py-class docutils literal notranslate">FileWrapper</code> class from <a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate">wsgiref.util</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.sendfile">
sendfile()<a class="headerlink" href="#wsgiref.handlers.BaseHandler.sendfile" title="Permalink to this definition">¶</a></dt>
<dd>Override to implement platform-specific file transmission. This method is
called only if the application’s return value is an instance of the class
specified by the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.wsgi_file_wrapper" title="wsgiref.handlers.BaseHandler.wsgi_file_wrapper"><code class="xref py py-attr docutils literal notranslate">wsgi_file_wrapper</code></a> attribute. It should return a true
value if it was able to successfully transmit the file, so that the default
transmission code will not be executed. The default implementation of this
method just returns a false value.
</dd></dl>

Miscellaneous methods and attributes:
<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.origin_server">
origin_server<a class="headerlink" href="#wsgiref.handlers.BaseHandler.origin_server" title="Permalink to this definition">¶</a></dt>
<dd>This attribute should be set to a true value if the handler’s <a class="reference internal" href="#wsgiref.handlers.BaseHandler._write" title="wsgiref.handlers.BaseHandler._write"><code class="xref py py-meth docutils literal notranslate">_write()</code></a> and
<a class="reference internal" href="#wsgiref.handlers.BaseHandler._flush" title="wsgiref.handlers.BaseHandler._flush"><code class="xref py py-meth docutils literal notranslate">_flush()</code></a> are being used to communicate directly to the client, rather than
via a CGI-like gateway protocol that wants the HTTP status in a special
<code class="docutils literal notranslate">Status:</code> header.
This attribute’s default value is true in <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but false in
<a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate">BaseCGIHandler</code></a> and <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate">CGIHandler</code></a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.http_version">
http_version<a class="headerlink" href="#wsgiref.handlers.BaseHandler.http_version" title="Permalink to this definition">¶</a></dt>
<dd>If <a class="reference internal" href="#wsgiref.handlers.BaseHandler.origin_server" title="wsgiref.handlers.BaseHandler.origin_server"><code class="xref py py-attr docutils literal notranslate">origin_server</code></a> is true, this string attribute is used to set the HTTP
version of the response set to the client. It defaults to <code class="docutils literal notranslate">&quot;1.0&quot;</code>.
</dd></dl>

</dd></dl>

</section>
<section id="examples">
<h2>20.4.6. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
This is a working “Hello World” WSGI application:
<div class="highlight-default notranslate"><div class="highlight"><pre>from wsgiref.simple_server import make_server

# Every WSGI application must have an application object - a callable
# object that accepts two arguments. For that purpose, we&#39;re going to
# use a function (note that you&#39;re not limited to a function, you can
# use a class for example). The first argument passed to the function
# is a dictionary containing CGI-style environment variables and the
# second variable is the callable object (see PEP 333).
def hello_world_app(environ, start_response):
 status = &#39;200 OK&#39; # HTTP Status
 headers = [(&#39;Content-type&#39;, &#39;text/plain&#39;)] # HTTP Headers
 start_response(status, headers)

# The returned object is going to be printed
 return [&quot;Hello World&quot;]

httpd = make_server(&#39;&#39;, 8000, hello_world_app)
print &quot;Serving on port 8000...&quot;

# Serve until process is killed
httpd.serve_forever()
</pre></div>
</div>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">20.4. <code class="xref py py-mod docutils literal notranslate">wsgiref</code> — WSGI Utilities and Reference Implementation</a><ul>
<li><a class="reference internal" href="#module-wsgiref.util">20.4.1. <code class="xref py py-mod docutils literal notranslate">wsgiref.util</code> – WSGI environment utilities</a></li>
<li><a class="reference internal" href="#module-wsgiref.headers">20.4.2. <code class="xref py py-mod docutils literal notranslate">wsgiref.headers</code> – WSGI response header tools</a></li>
<li><a class="reference internal" href="#module-wsgiref.simple_server">20.4.3. <code class="xref py py-mod docutils literal notranslate">wsgiref.simple_server</code> – a simple WSGI HTTP server</a></li>
<li><a class="reference internal" href="#module-wsgiref.validate">20.4.4. <code class="xref py py-mod docutils literal notranslate">wsgiref.validate</code> — WSGI conformance checker</a></li>
<li><a class="reference internal" href="#module-wsgiref.handlers">20.4.5. <code class="xref py py-mod docutils literal notranslate">wsgiref.handlers</code> – server/gateway base classes</a></li>
<li><a class="reference internal" href="#examples">20.4.6. Examples</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="cgitb.html"
 title="previous chapter">20.3. <code class="xref py py-mod docutils literal notranslate">cgitb</code> — Traceback manager for CGI scripts</a>
 <h4>Next topic</h4>
 <a href="urllib.html"
 title="next chapter">20.5. <code class="xref py py-mod docutils literal notranslate">urllib</code> — Open arbitrary resources by URL</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/wsgiref.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="urllib.html" title="20.5. urllib — Open arbitrary resources by URL"
 >next</a> |</li>
 <li class="right" >
 <a href="cgitb.html" title="20.3. cgitb — Traceback manager for CGI scripts"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" >20. Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">20.4. <code class="xref py py-mod docutils literal notranslate">wsgiref</code> — WSGI Utilities and Reference Implementation</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : wsgiref.html