Differences between revisions 27 and 48 (spanning 21 versions)
Revision 27 as of 2004-05-24 11:04:15
Size: 9681
Editor: c-24-125-101-137
Comment:
Revision 48 as of 2008-11-15 13:59:52
Size: 3344
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
PythonLibraryReference PythonLibraryRefTemplate$

Python Library Ref
erence
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 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:
11. [:/InternetProtocolsAndSupport:Internet Protocols And Support] 12. [[/InternetDataHandling|Internet Data Handling]]
Line 48: Line 51:
12. [:/InternetDataHandling:Internet Data Handling] 13. [[/StructuredMarkupProcessingTools|Structured Markup Processing Tools]]
Line 50: Line 53:
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
14. [[/MultimediaServices|Multimedia Services]]
Line 109: Line 55:
13. [:/StructuredMarkupProcessingTools:Structured Markup Processing Tools] 15. [[/CryptographicServices|Cryptographic Services]]
Line 111: Line 57:
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
16. [[/GraphicalUserInterfacesWithTk|Graphical User Interfaces With Tk]]
Line 151: Line 59:
14. [:/MultimediaServices:Multimedia Services] 17. [[/RestrictedExecution|Restricted Execution]]
Line 153: Line 61:
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
18. [[/PythonLanguageServices|Python Language Services]]
Line 171: Line 63:
15. [:/CryptographicServices:Cryptographic Services] 19. [[/PythonCompilerPackage|Python Compiler Package]]
Line 173: Line 65:
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
20. [[/SgiIrixSpecificServices|Sgi Irix Specific Services]]
Line 179: Line 67:
16. [:/GraphicalUserInterfacesWithTk:Graphical User Interfaces With Tk] 21. [[/SunOsSpecificServices|Sun OS Specific Services]]
Line 181: Line 69:
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
22. [[/MsWindowsSpecificServices|MS Windows Specific Services]]
Line 201: Line 71:
17. [:/RestrictedExecution:Restricted Execution] A. [[/UndocumentedModules|Undocumented Modules]]
Line 203: Line 73:
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
B. [[/ReportingBugs|Reporting Bugs]]
Line 209: Line 75:
18. [:/PythonLanguageServices:Python Language Services] C. [[/HistoryAndLicense|History And License]]
Line 211: Line 77:
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
[[/ModuleIndex|Module Index]]
Line 232: Line 79:
19. [:/PythonCompilerPackage:Python Compiler Package] [[/PythonLibraryReferenceIndex|Python Library Reference Index]]
Line 234: Line 81:
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
[[/AboutThisDocument|About This Document]] ...
Line 243: Line 83:
20. [:/SgiIrixSpecificServices:Sgi Irix Specific Services] == Comments ==
Line 245: Line 85:
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
Another set of annotatable documentation is at http://pydoc.amk.ca/frame.html .
Line 265: Line 87:
21. [:/SunOsSpecificServices:Sun OS 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 267: Line 89:
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
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 279: Line 91:
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 303: 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!
----

PythonLibraryRefTemplate$

Python Library Reference

Guido van Rossum

Fred L. Drake, Jr., editor

PythonLabs

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!

Front Matter

Table Of Contents

1. Introduction

2. Built In Objects

3. Python Runtime Services

4. String Services

5. Miscellaneous Services

6. Generic Operating System Services

7. Optional Operating System Services

8. Unix Specific Services

9. The Python Debugger

10. The Python Profiler

11. Internet Protocols And Support

12. Internet Data Handling

13. Structured Markup Processing Tools

14. Multimedia Services

15. Cryptographic Services

16. Graphical User Interfaces With Tk

17. Restricted Execution

18. Python Language Services

19. Python Compiler Package

20. Sgi Irix Specific Services

21. Sun OS Specific Services

22. MS Windows Specific Services

A. Undocumented Modules

B. Reporting Bugs

C. History And License

Module Index

Python Library Reference Index

About This Document ...

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!


CategoryDocumentation

PythonLibraryReference (last edited 2008-11-15 13:59:52 by localhost)

Unable to edit the page? See the FrontPage for instructions.