13262
Comment:
|
← Revision 48 as of 2008-11-15 13:59:52 ⇥
3344
converted to 1.6 markup
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
PythonLibraryReference | PythonLibraryRefTemplate$ Python Library Reference |
Line 15: | Line 17: |
(conversion to Wiki Format by A. Lloyd Flanagan, who didn't know what he was getting into) | (conversion to Wiki Format by [[LloydFlanagan|A. Lloyd Flanagan]], who didn't know what he was getting into) |
Line 19: | Line 21: |
||<bgcolor='#E0E0FF'>Note: this is a posting of the official python documentation, designed to make it easy for people to add comments to individual sections. So '''PLEASE DON'T''' modify the existing text! It will probably just be overwritten and no one will realize you've done it. '''PLEASE DO''' add any and all comments at the end of the section they apply to. That's what it's for! || | ||<bgcolor='#E0E0FF'>Note: this is an unofficial posting of the official python documentation. So '''PLEASE DON'T''' modify the existing text! It will probably just be overwritten and no one will realize you've done it. '''PLEASE DO''' add any and all comments at the end of the section they apply to. That's what it's for! || |
Line 21: | Line 23: |
[:/FrontMatter:Front Matter] | [[/FrontMatter|Front Matter]] |
Line 23: | Line 25: |
TableOfContents | = Table Of Contents = |
Line 25: | Line 27: |
1. [:/Introduction:Introduction] | 1. [[/Introduction|Introduction]] |
Line 27: | Line 29: |
2. [:/BuiltInObjects:Built In Objects] | 2. [[/BuiltInObjects|Built In Objects]] |
Line 29: | Line 31: |
3. [:/PythonRuntimeServices:Python Runtime Services] | 3. [[/PythonRuntimeServices|Python Runtime Services]] |
Line 31: | Line 33: |
4. [:/StringServices:String Services] | 4. [[/StringServices|String Services]] |
Line 33: | Line 35: |
5. [:/MiscellaneousServices:Miscellaneous Services] | 5. [[/MiscellaneousServices|Miscellaneous Services]] |
Line 35: | Line 37: |
6. [:/GenericOperatingSystemServices:Generic Operating System Services] | 6. [[/GenericOperatingSystemServices|Generic Operating System Services]] |
Line 37: | Line 39: |
7. [:/OptionalOperatingSystemServices:Optional Operating System Services] | 7. [[/OptionalOperatingSystemServices|Optional Operating System Services]] |
Line 39: | Line 41: |
8. [[/UnixSpecificServices|Unix Specific Services]] | |
Line 40: | Line 43: |
8. [:/UnixSpecificServices:Unix Specific Services] | 9. [[/ThePythonDebugger|The Python Debugger]] |
Line 42: | Line 45: |
9. [:/ThePythonDebugger:The Python Debugger] | 10. [[/ThePythonProfiler|The Python Profiler]] |
Line 44: | Line 47: |
10. [:/ThePythonProfiler:The Python Profiler] | 11. [[/InternetProtocolsAndSupport|Internet Protocols And Support]] |
Line 46: | Line 49: |
10.1 Introduction to the profiler 10.2 How Is This Profiler Different From The Old Profiler? 10.3 Instant Users Manual 10.4 What Is Deterministic Profiling? 10.5 Reference Manual 10.5.1 The Stats Class 10.6 Limitations 10.7 Calibration 10.8 Extensions -- Deriving Better Profilers 10.9 hotshot -- High performance logging profiler 10.9.1 Profile Objects 10.9.2 Using hotshot data 10.9.3 Example Usage 10.10 timeit -- Measure execution time of small code snippets 10.10.1 Command Line Interface 10.10.2 Examples |
12. [[/InternetDataHandling|Internet Data Handling]] |
Line 63: | Line 51: |
11. [:/InternetProtocolsAndSupport:Internet Protocols And Support] | 13. [[/StructuredMarkupProcessingTools|Structured Markup Processing Tools]] |
Line 65: | Line 53: |
11.1 webbrowser -- Convenient Web-browser controller 11.1.1 Browser Controller Objects 11.2 cgi -- Common Gateway Interface support. 11.2.1 Introduction 11.2.2 Using the cgi module 11.2.3 Higher Level Interface 11.2.4 Old classes 11.2.5 Functions 11.2.6 Caring about security 11.2.7 Installing your CGI script on a Unix system 11.2.8 Testing your CGI script 11.2.9 Debugging CGI scripts 11.2.10 Common problems and solutions 11.3 cgitb -- Traceback manager for CGI scripts 11.4 urllib -- Open arbitrary resources by URL 11.4.1 URLopener Objects 11.4.2 Examples 11.5 urllib2 -- extensible library for opening URLs 11.5.1 Request Objects 11.5.2 OpenerDirector Objects 11.5.3 BaseHandler Objects 11.5.4 HTTPRedirectHandler Objects 11.5.5 ProxyHandler Objects 11.5.6 HTTPPasswordMgr Objects 11.5.7 AbstractBasicAuthHandler Objects 11.5.8 HTTPBasicAuthHandler Objects 11.5.9 ProxyBasicAuthHandler Objects 11.5.10 AbstractDigestAuthHandler Objects 11.5.11 HTTPDigestAuthHandler Objects 11.5.12 ProxyDigestAuthHandler Objects 11.5.13 HTTPHandler Objects 11.5.14 HTTPSHandler Objects 11.5.15 FileHandler Objects 11.5.16 FTPHandler Objects 11.5.17 CacheFTPHandler Objects 11.5.18 GopherHandler Objects 11.5.19 UnknownHandler Objects 11.5.20 Examples 11.6 httplib -- HTTP protocol client 11.6.1 HTTPConnection Objects 11.6.2 HTTPResponse Objects 11.6.3 Examples 11.7 ftplib -- FTP protocol client 11.7.1 FTP Objects 11.8 gopherlib -- Gopher protocol client 11.9 poplib -- POP3 protocol client 11.9.1 POP3 Objects 11.9.2 POP3 Example 11.10 imaplib -- IMAP4 protocol client 11.10.1 IMAP4 Objects 11.10.2 IMAP4 Example 11.11 nntplib -- NNTP protocol client 11.11.1 NNTP Objects 11.12 smtplib -- SMTP protocol client 11.12.1 SMTP Objects 11.12.2 SMTP Example 11.13 telnetlib -- Telnet client 11.13.1 Telnet Objects 11.13.2 Telnet Example 11.14 urlparse -- Parse URLs into components 11.15 SocketServer -- A framework for network servers 11.16 BaseHTTPServer -- Basic HTTP server 11.17 SimpleHTTPServer -- Simple HTTP request handler 11.18 CGIHTTPServer -- CGI-capable HTTP request handler 11.19 Cookie -- HTTP state management 11.19.1 Cookie Objects 11.19.2 Morsel Objects 11.19.3 Example 11.20 xmlrpclib -- XML-RPC client access 11.20.1 ServerProxy Objects 11.20.2 Boolean Objects 11.20.3 DateTime Objects 11.20.4 Binary Objects 11.20.5 Fault Objects 11.20.6 ProtocolError Objects 11.20.7 Convenience Functions 11.20.8 Example of Client Usage 11.21 SimpleXMLRPCServer -- Basic XML-RPC server 11.21.1 SimpleXMLRPCServer Objects 11.21.2 CGIXMLRPCRequestHandler 11.22 DocXMLRPCServer -- Self-documenting XML-RPC server 11.22.1 DocXMLRPCServer Objects 11.22.2 DocCGIXMLRPCRequestHandler 11.23 asyncore -- Asynchronous socket handler 11.23.1 asyncore Example basic HTTP client 11.24 asynchat -- Asynchronous socket command/response handler 11.24.1 asynchat - Auxiliary Classes and Functions 11.24.2 asynchat Example |
14. [[/MultimediaServices|Multimedia Services]] |
Line 154: | Line 55: |
12. [:/InternetDataHandling:Internet Data Handling] | 15. [[/CryptographicServices|Cryptographic Services]] |
Line 156: | Line 57: |
12.1 formatter -- Generic output formatting 12.1.1 The Formatter Interface 12.1.2 Formatter Implementations 12.1.3 The Writer Interface 12.1.4 Writer Implementations 12.2 email -- An email and MIME handling package 12.2.1 Representing an email message 12.2.2 Parsing email messages 12.2.3 Generating MIME documents 12.2.4 Creating email and MIME objects from scratch 12.2.5 Internationalized headers 12.2.6 Representing character sets 12.2.7 Encoders 12.2.8 Exception classes 12.2.9 Miscellaneous utilities 12.2.10 Iterators 12.2.11 Differences from email v1 (up to Python 2.2.1) 12.2.12 Differences from mimelib 12.2.13 Examples 12.3 mailcap -- Mailcap file handling. 12.4 mailbox -- Read various mailbox formats 12.4.1 Mailbox Objects 12.5 mhlib -- Access to MH mailboxes 12.5.1 MH Objects 12.5.2 Folder Objects 12.5.3 Message Objects 12.6 mimetools -- Tools for parsing MIME messages 12.6.1 Additional Methods of Message Objects 12.7 mimetypes -- Map filenames to MIME types 12.7.1 MimeTypes Objects 12.8 MimeWriter -- Generic MIME file writer 12.8.1 MimeWriter Objects 12.9 mimify -- MIME processing of mail messages 12.10 multifile -- Support for files containing distinct parts 12.10.1 MultiFile Objects 12.10.2 MultiFile Example 12.11 rfc822 -- Parse RFC 2822 mail headers 12.11.1 Message Objects 12.11.2 AddressList Objects 12.12 base64 -- Encode and decode MIME base64 data 12.13 binascii -- Convert between binary and ASCII 12.14 binhex -- Encode and decode binhex4 files 12.14.1 Notes 12.15 quopri -- Encode and decode MIME quoted-printable data 12.16 uu -- Encode and decode uuencode files 12.17 xdrlib -- Encode and decode XDR data 12.17.1 Packer Objects 12.17.2 Unpacker Objects 12.17.3 Exceptions 12.18 netrc -- netrc file processing 12.18.1 netrc Objects 12.19 robotparser -- Parser for robots.txt 12.20 csv -- CSV File Reading and Writing 12.20.1 Module Contents 12.20.2 Dialects and Formatting Parameters 12.20.3 Reader Objects 12.20.4 Writer Objects 12.20.5 Examples |
16. [[/GraphicalUserInterfacesWithTk|Graphical User Interfaces With Tk]] |
Line 215: | Line 59: |
13. [:/StructuredMarkupProcessingTools:Structured Markup Processing Tools] | 17. [[/RestrictedExecution|Restricted Execution]] |
Line 217: | Line 61: |
13.1 HTMLParser -- Simple HTML and XHTML parser 13.1.1 Example HTML Parser Application 13.2 sgmllib -- Simple SGML parser 13.3 htmllib -- A parser for HTML documents 13.3.1 HTMLParser Objects 13.4 htmlentitydefs -- Definitions of HTML general entities 13.5 xml.parsers.expat -- Fast XML parsing using Expat 13.5.1 XMLParser Objects 13.5.2 ExpatError Exceptions 13.5.3 Example 13.5.4 Content Model Descriptions 13.5.5 Expat error constants 13.6 xml.dom -- The Document Object Model API 13.6.1 Module Contents 13.6.2 Objects in the DOM 13.6.3 Conformance 13.7 xml.dom.minidom -- Lightweight DOM implementation 13.7.1 DOM Objects 13.7.2 DOM Example 13.7.3 minidom and the DOM standard 13.8 xml.dom.pulldom -- Support for building partial DOM trees 13.8.1 DOMEventStream Objects 13.9 xml.sax -- Support for SAX2 parsers 13.9.1 SAXException Objects 13.10 xml.sax.handler -- Base classes for SAX handlers 13.10.1 ContentHandler Objects 13.10.2 DTDHandler Objects 13.10.3 EntityResolver Objects 13.10.4 ErrorHandler Objects 13.11 xml.sax.saxutils -- SAX Utilities 13.12 xml.sax.xmlreader -- Interface for XML parsers 13.12.1 XMLReader Objects 13.12.2 IncrementalParser Objects 13.12.3 Locator Objects 13.12.4 InputSource Objects 13.12.5 The Attributes Interface 13.12.6 The AttributesNS Interface 13.13 xmllib -- A parser for XML documents 13.13.1 XML Namespaces |
18. [[/PythonLanguageServices|Python Language Services]] |
Line 257: | Line 63: |
14. [:/MultimediaServices:Multimedia Services] | 19. [[/PythonCompilerPackage|Python Compiler Package]] |
Line 259: | Line 65: |
14.1 audioop -- Manipulate raw audio data 14.2 imageop -- Manipulate raw image data 14.3 aifc -- Read and write AIFF and AIFC files 14.4 sunau -- Read and write Sun AU files 14.4.1 AU_read Objects 14.4.2 AU_write Objects 14.5 wave -- Read and write WAV files 14.5.1 Wave_read Objects 14.5.2 Wave_write Objects 14.6 chunk -- Read IFF chunked data 14.7 colorsys -- Conversions between color systems 14.8 rgbimg -- Read and write SGI RGB files 14.9 imghdr -- Determine the type of an image 14.10 sndhdr -- Determine type of sound file 14.11 ossaudiodev -- Access to OSS-compatible audio devices 14.11.1 Audio Device Objects 14.11.2 Mixer Device Objects |
20. [[/SgiIrixSpecificServices|Sgi Irix Specific Services]] |
Line 277: | Line 67: |
15. [:/CryptographicServices:Cryptographic Services] | 21. [[/SunOsSpecificServices|Sun OS Specific Services]] |
Line 279: | Line 69: |
15.1 hmac -- Keyed-Hashing for Message Authentication 15.2 md5 -- MD5 message digest algorithm 15.3 sha -- SHA-1 message digest algorithm 15.4 mpz -- GNU arbitrary magnitude integers 15.5 rotor -- Enigma-like encryption and decryption |
22. [[/MsWindowsSpecificServices|MS Windows Specific Services]] |
Line 285: | Line 71: |
16. [:/GraphicalUserInterfacesWithTk:Graphical User Interfaces With Tk] | A. [[/UndocumentedModules|Undocumented Modules]] |
Line 287: | Line 73: |
16.1 Tkinter -- Python interface to Tcl/Tk 16.1.1 Tkinter Modules 16.1.2 Tkinter Life Preserver 16.1.3 A (Very) Quick Look at Tcl/Tk 16.1.4 Mapping Basic Tk into Tkinter 16.1.5 How Tk and Tkinter are Related 16.1.6 Handy Reference 16.2 Tix -- Extension widgets for Tk 16.2.1 Using Tix 16.2.2 Tix Widgets 16.2.3 Tix Commands 16.3 ScrolledText -- Scrolled Text Widget 16.4 turtle -- Turtle graphics for Tk 16.4.1 Pen and RawPen Objects 16.5 Idle 16.5.1 Menus 16.5.2 Basic editing and navigation 16.5.3 Syntax colors 16.6 Other Graphical User Interface Packages |
B. [[/ReportingBugs|Reporting Bugs]] |
Line 307: | Line 75: |
17. [:/RestrictedExecution:Restricted Execution] | C. [[/HistoryAndLicense|History And License]] |
Line 309: | Line 77: |
17.1 rexec -- Restricted execution framework 17.1.1 RExec Objects 17.1.2 Defining restricted environments 17.1.3 An example 17.2 Bastion -- Restricting access to objects |
[[/ModuleIndex|Module Index]] |
Line 315: | Line 79: |
18. [:/PythonLanguageServices:Python Language Services] | [[/PythonLibraryReferenceIndex|Python Library Reference Index]] |
Line 317: | Line 81: |
18.1 parser -- Access Python parse trees 18.1.1 Creating AST Objects 18.1.2 Converting AST Objects 18.1.3 Queries on AST Objects 18.1.4 Exceptions and Error Handling 18.1.5 AST Objects 18.1.6 Examples 18.2 symbol -- Constants used with Python parse trees 18.3 token -- Constants used with Python parse trees 18.4 keyword -- Testing for Python keywords 18.5 tokenize -- Tokenizer for Python source 18.6 tabnanny -- Detection of ambiguous indentation 18.7 pyclbr -- Python class browser support 18.7.1 Class Descriptor Objects 18.7.2 Function Descriptor Objects 18.8 py_compile -- Compile Python source files 18.9 compileall -- Byte-compile Python libraries 18.10 dis -- Disassembler for Python byte code 18.10.1 Python Byte Code Instructions 18.11 distutils -- Building and installing Python modules |
[[/AboutThisDocument|About This Document]] ... |
Line 338: | Line 83: |
19. [:/PythonCompilerPackage:Python Compiler Package] | == Comments == |
Line 340: | Line 85: |
19.1 The basic interface 19.2 Limitations 19.3 Python Abstract Syntax 19.3.1 AST Nodes 19.3.2 Assignment nodes 19.3.3 Examples 19.4 Using Visitors to Walk ASTs 19.5 Bytecode Generation |
Another set of annotatable documentation is at http://pydoc.amk.ca/frame.html . |
Line 349: | Line 87: |
20. [:/SgiIrixSpecificServices:Sgi Irix Specific Services] | That site wraps a frameset around the Python 2.3.4 documentation and adds some JavaScript that updates another frame to display a Wiki page for the documentation page you're viewing. |
Line 351: | Line 89: |
20.1 al -- Audio functions on the SGI 20.1.1 Configuration Objects 20.1.2 Port Objects 20.2 AL -- Constants used with the al module 20.3 cd -- CD-ROM access on SGI systems 20.3.1 Player Objects 20.3.2 Parser Objects 20.4 fl -- FORMS library for graphical user interfaces 20.4.1 Functions Defined in Module fl 20.4.2 Form Objects 20.4.3 FORMS Objects 20.5 FL -- Constants used with the fl module 20.6 flp -- Functions for loading stored FORMS designs 20.7 fm -- Font Manager interface 20.8 gl -- Graphics Library interface 20.9 DEVICE -- Constants used with the gl module 20.10 GL -- Constants used with the gl module 20.11 imgfile -- Support for SGI imglib files 20.12 jpeg -- Read and write JPEG files |
Please go and add any commentary, links, or other material you wish. If it becomes clear that people will actually use these annotated docs, they'll probably get moved onto python.org. |
Line 371: | Line 91: |
21. [:/SunOsSpecificServices:Sun OS Specific Services] 21.1 sunaudiodev -- Access to Sun audio hardware 21.1.1 Audio Device Objects 21.2 SUNAUDIODEV -- Constants used with sunaudiodev 22. MS Windows Specific Services 22.1 msvcrt - Useful routines from the MS VC++ runtime 22.1.1 File Operations 22.1.2 Console I/O 22.1.3 Other Functions 22.2 _winreg - Windows registry access 22.2.1 Registry Handle Objects 22.3 winsound -- Sound-playing interface for Windows A. [:/UndocumentedModules:Undocumented Modules] A.1 Frameworks A.2 Miscellaneous useful utilities A.3 Platform specific modules A.4 Multimedia A.5 Obsolete A.6 SGI-specific Extension modules B. [:/ReportingBugs:Reporting Bugs] C. [:/HistoryAndLicense:History And License] C.1 History of the software C.2 Terms and conditions for accessing or otherwise using Python [:/ModuleIndex:Module Index] [:/PythonLibraryReferenceIndex:Python Library Reference Index] [:/AboutThisDocument:About This Document] ... |
AndrewKuchling -- 2004-09-09 |
Line 409: | Line 94: |
LloydFlanagan -- 10/8/2004 I've checked out Andrew's setup. It's brilliant! I've been looking at a system for parsing the current CVS documentation, creating wiki pages out of it, and updating them as the docs are changed. Meanwhile, Andrew has come up with a scheme to view the standard HTML pages side-by-side with comments. Since that's so functional, and these docs are obsolete already, I'll probably stop work on this version until I think of something better. Err, make that "if". Thanks Andrew! ---- |
Python Library Reference
Guido van Rossum
Fred L. Drake, Jr., editor
Email: docs@python.org
Release 2.3.3
December 19, 2003
(conversion to Wiki Format by A. Lloyd Flanagan, who didn't know what he was getting into)
Note: this is an unofficial posting of the official python documentation. So PLEASE DON'T modify the existing text! It will probably just be overwritten and no one will realize you've done it. PLEASE DO add any and all comments at the end of the section they apply to. That's what it's for! |
Table Of Contents
1. Introduction
6. Generic Operating System Services
7. Optional Operating System Services
11. Internet Protocols And Support
13. Structured Markup Processing Tools
16. Graphical User Interfaces With Tk
20. Sgi Irix Specific Services
22. MS Windows Specific Services
Python Library Reference Index
Comments
Another set of annotatable documentation is at http://pydoc.amk.ca/frame.html .
That site wraps a frameset around the Python 2.3.4 documentation and adds some JavaScript that updates another frame to display a Wiki page for the documentation page you're viewing.
Please go and add any commentary, links, or other material you wish. If it becomes clear that people will actually use these annotated docs, they'll probably get moved onto python.org.
AndrewKuchling -- 2004-09-09
LloydFlanagan -- 10/8/2004
I've checked out Andrew's setup. It's brilliant! I've been looking at a system for parsing the current CVS documentation, creating wiki pages out of it, and updating them as the docs are changed. Meanwhile, Andrew has come up with a scheme to view the standard HTML pages side-by-side with comments.
Since that's so functional, and these docs are obsolete already, I'll probably stop work on this version until I think of something better. Err, make that "if".
Thanks Andrew!