Python Documentation contents¶
- What’s New in Python
- What’s New in Python 2.7
- The Future for Python 2.x
- Changes to the Handling of Deprecation Warnings
- Post-EOS fixes
- Python 3.1 Features
- PEP 372: Adding an Ordered Dictionary to collections
- PEP 378: Format Specifier for Thousands Separator
- PEP 389: The argparse Module for Parsing Command Lines
- PEP 391: Dictionary-Based Configuration For Logging
- PEP 3106: Dictionary Views
- PEP 3137: The memoryview Object
- Other Language Changes
- New and Improved Modules
- Build and C API Changes
- Other Changes and Fixes
- Porting to Python 2.7
- New Features Added to Python 2.7 Maintenance Releases
- Two new environment variables for debug mode
- PEP 434: IDLE Enhancement Exception for All Branches
- PEP 466: Network Security Enhancements for Python 2.7
- PEP 477: Backport ensurepip (PEP 453) to Python 2.7
- PEP 476: Enabling certificate verification by default for stdlib http clients
- PEP 493: HTTPS verification migration tools for Python 2.7
- New
make regen-allbuild target - Removal of
make touchbuild target
- Acknowledgements
- What’s New in Python 2.6
- Python 3.0
- Changes to the Development Process
- PEP 343: The ‘with’ statement
- PEP 366: Explicit Relative Imports From a Main Module
- PEP 370: Per-user
site-packagesDirectory - PEP 371: The
multiprocessingPackage - PEP 3101: Advanced String Formatting
- PEP 3105:
printAs a Function - PEP 3110: Exception-Handling Changes
- PEP 3112: Byte Literals
- PEP 3116: New I/O Library
- PEP 3118: Revised Buffer Protocol
- PEP 3119: Abstract Base Classes
- PEP 3127: Integer Literal Support and Syntax
- PEP 3129: Class Decorators
- PEP 3141: A Type Hierarchy for Numbers
- Other Language Changes
- New and Improved Modules
- Deprecations and Removals
- Build and C API Changes
- Porting to Python 2.6
- Acknowledgements
- What’s New in Python 2.5
- PEP 308: Conditional Expressions
- PEP 309: Partial Function Application
- PEP 314: Metadata for Python Software Packages v1.1
- PEP 328: Absolute and Relative Imports
- PEP 338: Executing Modules as Scripts
- PEP 341: Unified try/except/finally
- PEP 342: New Generator Features
- PEP 343: The ‘with’ statement
- PEP 352: Exceptions as New-Style Classes
- PEP 353: Using ssize_t as the index type
- PEP 357: The ‘__index__’ method
- Other Language Changes
- New, Improved, and Removed Modules
- Build and C API Changes
- Porting to Python 2.5
- Acknowledgements
- What’s New in Python 2.4
- PEP 218: Built-In Set Objects
- PEP 237: Unifying Long Integers and Integers
- PEP 289: Generator Expressions
- PEP 292: Simpler String Substitutions
- PEP 318: Decorators for Functions and Methods
- PEP 322: Reverse Iteration
- PEP 324: New subprocess Module
- PEP 327: Decimal Data Type
- PEP 328: Multi-line Imports
- PEP 331: Locale-Independent Float/String Conversions
- Other Language Changes
- New, Improved, and Deprecated Modules
- Build and C API Changes
- Porting to Python 2.4
- Acknowledgements
- What’s New in Python 2.3
- PEP 218: A Standard Set Datatype
- PEP 255: Simple Generators
- PEP 263: Source Code Encodings
- PEP 273: Importing Modules from ZIP Archives
- PEP 277: Unicode file name support for Windows NT
- PEP 278: Universal Newline Support
- PEP 279: enumerate()
- PEP 282: The logging Package
- PEP 285: A Boolean Type
- PEP 293: Codec Error Handling Callbacks
- PEP 301: Package Index and Metadata for Distutils
- PEP 302: New Import Hooks
- PEP 305: Comma-separated Files
- PEP 307: Pickle Enhancements
- Extended Slices
- Other Language Changes
- New, Improved, and Deprecated Modules
- Pymalloc: A Specialized Object Allocator
- Build and C API Changes
- Other Changes and Fixes
- Porting to Python 2.3
- Acknowledgements
- What’s New in Python 2.2
- Introduction
- PEPs 252 and 253: Type and Class Changes
- PEP 234: Iterators
- PEP 255: Simple Generators
- PEP 237: Unifying Long Integers and Integers
- PEP 238: Changing the Division Operator
- Unicode Changes
- PEP 227: Nested Scopes
- New and Improved Modules
- Interpreter Changes and Fixes
- Other Changes and Fixes
- Acknowledgements
- What’s New in Python 2.1
- Introduction
- PEP 227: Nested Scopes
- PEP 236: __future__ Directives
- PEP 207: Rich Comparisons
- PEP 230: Warning Framework
- PEP 229: New Build System
- PEP 205: Weak References
- PEP 232: Function Attributes
- PEP 235: Importing Modules on Case-Insensitive Platforms
- PEP 217: Interactive Display Hook
- PEP 208: New Coercion Model
- PEP 241: Metadata in Python Packages
- New and Improved Modules
- Other Changes and Fixes
- Acknowledgements
- What’s New in Python 2.0
- Introduction
- What About Python 1.6?
- New Development Process
- Unicode
- List Comprehensions
- Augmented Assignment
- String Methods
- Garbage Collection of Cycles
- Other Core Changes
- Porting to 2.0
- Extending/Embedding Changes
- Distutils: Making Modules Easy to Install
- XML Modules
- Module changes
- New modules
- IDLE Improvements
- Deleted and Deprecated Modules
- Acknowledgements
- What’s New in Python 2.7
- The Python Tutorial
- 1. Whetting Your Appetite
- 2. Using the Python Interpreter
- 3. An Informal Introduction to Python
- 4. More Control Flow Tools
- 5. Data Structures
- 6. Modules
- 7. Input and Output
- 8. Errors and Exceptions
- 9. Classes
- 10. Brief Tour of the Standard Library
- 10.1. Operating System Interface
- 10.2. File Wildcards
- 10.3. Command Line Arguments
- 10.4. Error Output Redirection and Program Termination
- 10.5. String Pattern Matching
- 10.6. Mathematics
- 10.7. Internet Access
- 10.8. Dates and Times
- 10.9. Data Compression
- 10.10. Performance Measurement
- 10.11. Quality Control
- 10.12. Batteries Included
- 11. Brief Tour of the Standard Library — Part II
- 12. What Now?
- 13. Interactive Input Editing and History Substitution
- 14. Floating Point Arithmetic: Issues and Limitations
- 15. Appendix
- Python Setup and Usage
- The Python Language Reference
- 1. Introduction
- 2. Lexical analysis
- 3. Data model
- 3.1. Objects, values and types
- 3.2. The standard type hierarchy
- 3.3. New-style and classic classes
- 3.4. Special method names
- 3.4.1. Basic customization
- 3.4.2. Customizing attribute access
- 3.4.3. Customizing class creation
- 3.4.4. Customizing instance and subclass checks
- 3.4.5. Emulating callable objects
- 3.4.6. Emulating container types
- 3.4.7. Additional methods for emulation of sequence types
- 3.4.8. Emulating numeric types
object.__add__()object.__sub__()object.__mul__()object.__floordiv__()object.__mod__()object.__divmod__()object.__pow__()object.__lshift__()object.__rshift__()object.__and__()object.__xor__()object.__or__()object.__div__()object.__truediv__()object.__radd__()object.__rsub__()object.__rmul__()object.__rdiv__()object.__rtruediv__()object.__rfloordiv__()object.__rmod__()object.__rdivmod__()object.__rpow__()object.__rlshift__()object.__rrshift__()object.__rand__()object.__rxor__()object.__ror__()object.__iadd__()object.__isub__()object.__imul__()object.__idiv__()object.__itruediv__()object.__ifloordiv__()object.__imod__()object.__ipow__()object.__ilshift__()object.__irshift__()object.__iand__()object.__ixor__()object.__ior__()object.__neg__()object.__pos__()object.__abs__()object.__invert__()object.__complex__()object.__int__()object.__long__()object.__float__()object.__oct__()object.__hex__()object.__index__()object.__coerce__()
- 3.4.9. Coercion rules
- 3.4.10. With Statement Context Managers
- 3.4.11. Special method lookup for old-style classes
- 3.4.12. Special method lookup for new-style classes
- 4. Execution model
- 5. Expressions
- 5.1. Arithmetic conversions
- 5.2. Atoms
- 5.3. Primaries
- 5.4. The power operator
- 5.5. Unary arithmetic and bitwise operations
- 5.6. Binary arithmetic operations
- 5.7. Shifting operations
- 5.8. Binary bitwise operations
- 5.9. Comparisons
- 5.10. Boolean operations
- 5.11. Conditional Expressions
- 5.12. Lambdas
- 5.13. Expression lists
- 5.14. Evaluation order
- 5.15. Operator precedence
- 6. Simple statements
- 6.1. Expression statements
- 6.2. Assignment statements
- 6.3. The
assertstatement - 6.4. The
passstatement - 6.5. The
delstatement - 6.6. The
printstatement - 6.7. The
returnstatement - 6.8. The
yieldstatement - 6.9. The
raisestatement - 6.10. The
breakstatement - 6.11. The
continuestatement - 6.12. The
importstatement - 6.13. The
globalstatement - 6.14. The
execstatement
- 7. Compound statements
- 8. Top-level components
- 9. Full Grammar specification
- The Python Standard Library
- 1. Introduction
- 2. Built-in Functions
abs()all()any()basestring()bin()boolbytearraycallable()chr()classmethod()cmp()compile()complexdelattr()dir()divmod()enumerate()eval()execfile()file()filter()floatformat()getattr()globals()hasattr()hash()help()hex()id()input()intisinstance()issubclass()iter()len()locals()longmap()max()min()next()objectoct()open()ord()pow()print()propertyrange()raw_input()reduce()reload()repr()reversed()round()setattr()slicesorted()staticmethod()strsum()super()tuple()typeunichr()unicode()vars()xrange()zip()__import__()
- 3. Non-essential Built-in Functions
- 4. Built-in Constants
- 5. Built-in Types
- 5.1. Truth Value Testing
- 5.2. Boolean Operations —
and,or,not - 5.3. Comparisons
- 5.4. Numeric Types —
int,float,long,complex - 5.5. Iterator Types
- 5.6. Sequence Types —
str,unicode,list,tuple,bytearray,buffer,xrange- 5.6.1. String Methods
str.capitalize()str.center()str.count()str.decode()str.encode()str.endswith()str.expandtabs()str.find()str.format()str.index()str.isalnum()str.isalpha()str.isdigit()str.islower()str.isspace()str.istitle()str.isupper()str.join()str.ljust()str.lower()str.lstrip()str.partition()str.replace()str.rfind()str.rindex()str.rjust()str.rpartition()str.rsplit()str.rstrip()str.split()str.splitlines()unicode.splitlines()str.startswith()str.strip()str.swapcase()str.title()str.translate()str.upper()str.zfill()unicode.isnumeric()unicode.isdecimal()
- 5.6.2. String Formatting Operations
- 5.6.3. XRange Type
- 5.6.4. Mutable Sequence Types
- 5.6.1. String Methods
- 5.7. Set Types —
set,frozensetsetfrozensetfrozenset.isdisjoint()frozenset.issubset()frozenset.issuperset()frozenset.union()frozenset.intersection()frozenset.difference()frozenset.symmetric_difference()frozenset.copy()frozenset.update()frozenset.intersection_update()frozenset.difference_update()frozenset.symmetric_difference_update()frozenset.add()frozenset.remove()frozenset.discard()frozenset.pop()frozenset.clear()
- 5.8. Mapping Types —
dict - 5.9. File Objects
- 5.10. memoryview type
- 5.11. Context Manager Types
- 5.12. Other Built-in Types
- 5.13. Special Attributes
- 6. Built-in Exceptions
BaseExceptionExceptionStandardErrorArithmeticErrorBufferErrorLookupErrorEnvironmentErrorAssertionErrorAttributeErrorEOFErrorFloatingPointErrorGeneratorExitIOErrorImportErrorIndexErrorKeyErrorKeyboardInterruptMemoryErrorNameErrorNotImplementedErrorOSErrorOverflowErrorReferenceErrorRuntimeErrorStopIterationSyntaxErrorIndentationErrorTabErrorSystemErrorSystemExitTypeErrorUnboundLocalErrorUnicodeErrorUnicodeEncodeErrorUnicodeDecodeErrorUnicodeTranslateErrorValueErrorVMSErrorWindowsErrorZeroDivisionErrorWarningUserWarningDeprecationWarningPendingDeprecationWarningSyntaxWarningRuntimeWarningFutureWarningImportWarningUnicodeWarningBytesWarning- 6.1. Exception hierarchy
- 7. String Services
- 7.1.
string— Common string operations - 7.2.
re— Regular expression operations - 7.3.
struct— Interpret strings as packed binary data - 7.4.
difflib— Helpers for computing deltasSequenceMatcherDifferHtmlDiffcontext_diff()get_close_matches()ndiff()restore()unified_diff()IS_LINE_JUNK()IS_CHARACTER_JUNK()- 7.4.1. SequenceMatcher Objects
SequenceMatcherSequenceMatcher.set_seqs()SequenceMatcher.set_seq1()SequenceMatcher.set_seq2()SequenceMatcher.find_longest_match()SequenceMatcher.get_matching_blocks()SequenceMatcher.get_opcodes()SequenceMatcher.get_grouped_opcodes()SequenceMatcher.ratio()SequenceMatcher.quick_ratio()SequenceMatcher.real_quick_ratio()
- 7.4.2. SequenceMatcher Examples
- 7.4.3. Differ Objects
- 7.4.4. Differ Example
- 7.4.5. A command-line interface to difflib
- 7.5.
StringIO— Read and write strings as files - 7.6.
cStringIO— Faster version ofStringIO - 7.7.
textwrap— Text wrapping and filling - 7.8.
codecs— Codec registry and base classesencode()decode()register()lookup()getencoder()getdecoder()getincrementalencoder()getincrementaldecoder()getreader()getwriter()register_error()lookup_error()strict_errors()replace_errors()ignore_errors()xmlcharrefreplace_errors()backslashreplace_errors()open()EncodedFile()iterencode()iterdecode()BOMBOM_BEBOM_LEBOM_UTF8BOM_UTF16BOM_UTF16_BEBOM_UTF16_LEBOM_UTF32BOM_UTF32_BEBOM_UTF32_LE- 7.8.1. Codec Base Classes
- 7.8.2. Encodings and Unicode
- 7.8.3. Standard Encodings
- 7.8.4. Python Specific Encodings
- 7.8.5.
encodings.idna— Internationalized Domain Names in Applications - 7.8.6.
encodings.utf_8_sig— UTF-8 codec with BOM signature
- 7.9.
unicodedata— Unicode Database - 7.10.
stringprep— Internet String Preparation - 7.11.
fpformat— Floating point conversions
- 7.1.
- 8. Data Types
- 8.1.
datetime— Basic date and time typesMINYEARMAXYEAR- 8.1.1. Available Types
- 8.1.2.
timedeltaObjects - 8.1.3.
dateObjectsdatedate.today()date.fromtimestamp()date.fromordinal()date.mindate.maxdate.resolutiondate.yeardate.monthdate.daydate.replace()date.timetuple()date.toordinal()date.weekday()date.isoweekday()date.isocalendar()date.isoformat()date.__str__()date.ctime()date.strftime()date.__format__()
- 8.1.4.
datetimeObjectsdatetimedatetime.today()datetime.now()datetime.utcnow()datetime.fromtimestamp()datetime.utcfromtimestamp()datetime.fromordinal()datetime.combine()datetime.strptime()datetime.mindatetime.maxdatetime.resolutiondatetime.yeardatetime.monthdatetime.daydatetime.hourdatetime.minutedatetime.seconddatetime.microseconddatetime.tzinfodatetime.date()datetime.time()datetime.timetz()datetime.replace()datetime.astimezone()datetime.utcoffset()datetime.dst()datetime.tzname()datetime.timetuple()datetime.utctimetuple()datetime.toordinal()datetime.weekday()datetime.isoweekday()datetime.isocalendar()datetime.isoformat()datetime.__str__()datetime.ctime()datetime.strftime()datetime.__format__()
- 8.1.5.
timeObjects - 8.1.6.
tzinfoObjects - 8.1.7.
strftime()andstrptime()Behavior
- 8.2.
calendar— General calendar-related functions - 8.3.
collections— High-performance container datatypes - 8.4.
heapq— Heap queue algorithm - 8.5.
bisect— Array bisection algorithm - 8.6.
array— Efficient arrays of numeric valuesarrayArrayTypearray.typecodearray.itemsizearray.append()array.buffer_info()array.byteswap()array.count()array.extend()array.fromfile()array.fromlist()array.fromstring()array.fromunicode()array.index()array.insert()array.pop()array.read()array.remove()array.reverse()array.tofile()array.tolist()array.tostring()array.tounicode()array.write()
- 8.7.
sets— Unordered collections of unique elements - 8.8.
sched— Event scheduler - 8.9.
mutex— Mutual exclusion support - 8.10.
Queue— A synchronized queue class - 8.11.
weakref— Weak referencesrefproxy()getweakrefcount()getweakrefs()WeakKeyDictionaryWeakKeyDictionary.iterkeyrefs()WeakKeyDictionary.keyrefs()WeakValueDictionaryWeakValueDictionary.itervaluerefs()WeakValueDictionary.valuerefs()WeakSetReferenceTypeProxyTypeCallableProxyTypeProxyTypesReferenceError- 8.11.1. Weak Reference Objects
- 8.11.2. Example
- 8.12.
UserDict— Class wrapper for dictionary objects - 8.13.
UserList— Class wrapper for list objects - 8.14.
UserString— Class wrapper for string objects - 8.15.
types— Names for built-in typesNoneTypeTypeTypeBooleanTypeIntTypeLongTypeFloatTypeComplexTypeStringTypeUnicodeTypeTupleTypeListTypeDictTypeDictionaryTypeFunctionTypeLambdaTypeGeneratorTypeCodeTypeClassTypeInstanceTypeMethodTypeUnboundMethodTypeBuiltinFunctionTypeBuiltinMethodTypeModuleTypeFileTypeXRangeTypeSliceTypeEllipsisTypeTracebackTypeFrameTypeBufferTypeDictProxyTypeNotImplementedTypeGetSetDescriptorTypeMemberDescriptorTypeStringTypes
- 8.16.
new— Creation of runtime internal objects - 8.17.
copy— Shallow and deep copy operations - 8.18.
pprint— Data pretty printer - 8.19.
repr— Alternaterepr()implementation
- 8.1.
- 9. Numeric and Mathematical Modules
- 9.1.
numbers— Numeric abstract base classes - 9.2.
math— Mathematical functions - 9.3.
cmath— Mathematical functions for complex numbers - 9.4.
decimal— Decimal fixed point and floating point arithmetic- 9.4.1. Quick-start Tutorial
- 9.4.2. Decimal objects
DecimalDecimal.adjusted()Decimal.as_tuple()Decimal.canonical()Decimal.compare()Decimal.compare_signal()Decimal.compare_total()Decimal.compare_total_mag()Decimal.conjugate()Decimal.copy_abs()Decimal.copy_negate()Decimal.copy_sign()Decimal.exp()Decimal.from_float()Decimal.fma()Decimal.is_canonical()Decimal.is_finite()Decimal.is_infinite()Decimal.is_nan()Decimal.is_normal()Decimal.is_qnan()Decimal.is_signed()Decimal.is_snan()Decimal.is_subnormal()Decimal.is_zero()Decimal.ln()Decimal.log10()Decimal.logb()Decimal.logical_and()Decimal.logical_invert()Decimal.logical_or()Decimal.logical_xor()Decimal.max()Decimal.max_mag()Decimal.min()Decimal.min_mag()Decimal.next_minus()Decimal.next_plus()Decimal.next_toward()Decimal.normalize()Decimal.number_class()Decimal.quantize()Decimal.radix()Decimal.remainder_near()Decimal.rotate()Decimal.same_quantum()Decimal.scaleb()Decimal.shift()Decimal.sqrt()Decimal.to_eng_string()Decimal.to_integral()Decimal.to_integral_exact()Decimal.to_integral_value()
- 9.4.2.1. Logical operands
- 9.4.3. Context objects
getcontext()setcontext()localcontext()BasicContextExtendedContextDefaultContextContextContext.clear_flags()Context.copy()Context.copy_decimal()Context.create_decimal()Context.create_decimal_from_float()Context.Etiny()Context.Etop()Context.abs()Context.add()Context.canonical()Context.compare()Context.compare_signal()Context.compare_total()Context.compare_total_mag()Context.copy_abs()Context.copy_negate()Context.copy_sign()Context.divide()Context.divide_int()Context.divmod()Context.exp()Context.fma()Context.is_canonical()Context.is_finite()Context.is_infinite()Context.is_nan()Context.is_normal()Context.is_qnan()Context.is_signed()Context.is_snan()Context.is_subnormal()Context.is_zero()Context.ln()Context.log10()Context.logb()Context.logical_and()Context.logical_invert()Context.logical_or()Context.logical_xor()Context.max()Context.max_mag()Context.min()Context.min_mag()Context.minus()Context.multiply()Context.next_minus()Context.next_plus()Context.next_toward()Context.normalize()Context.number_class()Context.plus()Context.power()Context.quantize()Context.radix()Context.remainder()Context.remainder_near()Context.rotate()Context.same_quantum()Context.scaleb()Context.shift()Context.sqrt()Context.subtract()Context.to_eng_string()Context.to_integral_exact()Context.to_sci_string()
- 9.4.4. Signals
- 9.4.5. Floating Point Notes
- 9.4.6. Working with threads
- 9.4.7. Recipes
- 9.4.8. Decimal FAQ
- 9.5.
fractions— Rational numbers - 9.6.
random— Generate pseudo-random numbersseed()getstate()setstate()jumpahead()getrandbits()randrange()randint()choice()shuffle()sample()random()uniform()triangular()betavariate()expovariate()gammavariate()gauss()lognormvariate()normalvariate()vonmisesvariate()paretovariate()weibullvariate()WichmannHillwhseed()SystemRandom
- 9.7.
itertools— Functions creating iterators for efficient looping - 9.8.
functools— Higher-order functions and operations on callable objects - 9.9.
operator— Standard operators as functionslt()le()eq()ne()ge()gt()__lt__()__le__()__eq__()__ne__()__ge__()__gt__()not_()__not__()truth()is_()is_not()abs()__abs__()add()__add__()and_()__and__()div()__div__()floordiv()__floordiv__()index()__index__()inv()invert()__inv__()__invert__()lshift()__lshift__()mod()__mod__()mul()__mul__()neg()__neg__()or_()__or__()pos()__pos__()pow()__pow__()rshift()__rshift__()sub()__sub__()truediv()__truediv__()xor()__xor__()concat()__concat__()contains()__contains__()countOf()delitem()__delitem__()delslice()__delslice__()getitem()__getitem__()getslice()__getslice__()indexOf()repeat()__repeat__()sequenceIncludes()setitem()__setitem__()setslice()__setslice__()iadd()__iadd__()iand()__iand__()iconcat()__iconcat__()idiv()__idiv__()ifloordiv()__ifloordiv__()ilshift()__ilshift__()imod()__imod__()imul()__imul__()ior()__ior__()ipow()__ipow__()irepeat()__irepeat__()irshift()__irshift__()isub()__isub__()itruediv()__itruediv__()ixor()__ixor__()isCallable()isMappingType()isNumberType()isSequenceType()attrgetter()itemgetter()methodcaller()- 9.9.1. Mapping Operators to Functions
- 9.1.
- 10. File and Directory Access
- 10.1.
os.path— Common pathname manipulationsabspath()basename()commonprefix()dirname()exists()lexists()expanduser()expandvars()getatime()getmtime()getctime()getsize()isabs()isfile()isdir()islink()ismount()join()normcase()normpath()realpath()relpath()samefile()sameopenfile()samestat()split()splitdrive()splitext()splitunc()walk()supports_unicode_filenames
- 10.2.
fileinput— Iterate over lines from multiple input streams - 10.3.
stat— Interpretingstat()resultsS_ISDIR()S_ISCHR()S_ISBLK()S_ISREG()S_ISFIFO()S_ISLNK()S_ISSOCK()S_IMODE()S_IFMT()ST_MODEST_INOST_DEVST_NLINKST_UIDST_GIDST_SIZEST_ATIMEST_MTIMEST_CTIMES_IFSOCKS_IFLNKS_IFREGS_IFBLKS_IFDIRS_IFCHRS_IFIFOS_ISUIDS_ISGIDS_ISVTXS_IRWXUS_IRUSRS_IWUSRS_IXUSRS_IRWXGS_IRGRPS_IWGRPS_IXGRPS_IRWXOS_IROTHS_IWOTHS_IXOTHS_ENFMTS_IREADS_IWRITES_IEXECUF_NODUMPUF_IMMUTABLEUF_APPENDUF_OPAQUEUF_NOUNLINKUF_COMPRESSEDUF_HIDDENSF_ARCHIVEDSF_IMMUTABLESF_APPENDSF_NOUNLINKSF_SNAPSHOT
- 10.4.
statvfs— Constants used withos.statvfs() - 10.5.
filecmp— File and Directory Comparisonscmp()cmpfiles()- 10.5.1. The
dircmpclassdircmpdircmp.report()dircmp.report_partial_closure()dircmp.report_full_closure()dircmp.leftdircmp.rightdircmp.left_listdircmp.right_listdircmp.commondircmp.left_onlydircmp.right_onlydircmp.common_dirsdircmp.common_filesdircmp.common_funnydircmp.same_filesdircmp.diff_filesdircmp.funny_filesdircmp.subdirs
- 10.6.
tempfile— Generate temporary files and directories - 10.7.
glob— Unix style pathname pattern expansion - 10.8.
fnmatch— Unix filename pattern matching - 10.9.
linecache— Random access to text lines - 10.10.
shutil— High-level file operations - 10.11.
dircache— Cached directory listings - 10.12.
macpath— Mac OS 9 path manipulation functions
- 10.1.
- 11. Data Persistence
- 11.1.
pickle— Python object serialization - 11.2.
cPickle— A fasterpickle - 11.3.
copy_reg— Registerpicklesupport functions - 11.4.
shelve— Python object persistence - 11.5.
marshal— Internal Python object serialization - 11.6.
anydbm— Generic access to DBM-style databases - 11.7.
whichdb— Guess which DBM module created a database - 11.8.
dbm— Simple “database” interface - 11.9.
gdbm— GNU’s reinterpretation of dbm - 11.10.
dbhash— DBM-style interface to the BSD database library - 11.11.
bsddb— Interface to Berkeley DB library - 11.12.
dumbdbm— Portable DBM implementation - 11.13.
sqlite3— DB-API 2.0 interface for SQLite databases- 11.13.1. Module functions and constants
- 11.13.2. Connection Objects
ConnectionConnection.isolation_levelConnection.cursor()Connection.commit()Connection.rollback()Connection.close()Connection.execute()Connection.executemany()Connection.executescript()Connection.create_function()Connection.create_aggregate()Connection.create_collation()Connection.interrupt()Connection.set_authorizer()Connection.set_progress_handler()Connection.enable_load_extension()Connection.load_extension()Connection.row_factoryConnection.text_factoryConnection.total_changesConnection.iterdump
- 11.13.3. Cursor Objects
- 11.13.4. Row Objects
- 11.13.5. SQLite and Python types
- 11.13.6. Controlling Transactions
- 11.13.7. Using
sqlite3efficiently - 11.13.8. Common issues
- 11.1.
- 12. Data Compression and Archiving
- 12.1.
zlib— Compression compatible with gzip - 12.2.
gzip— Support for gzip files - 12.3.
bz2— Compression compatible with bzip2 - 12.4.
zipfile— Work with ZIP archivesBadZipfileLargeZipFilePyZipFileZipInfois_zipfile()ZIP_STOREDZIP_DEFLATED- 12.4.1. ZipFile Objects
- 12.4.2. PyZipFile Objects
- 12.4.3. ZipInfo Objects
ZipInfo.filenameZipInfo.date_timeZipInfo.compress_typeZipInfo.commentZipInfo.extraZipInfo.create_systemZipInfo.create_versionZipInfo.extract_versionZipInfo.reservedZipInfo.flag_bitsZipInfo.volumeZipInfo.internal_attrZipInfo.external_attrZipInfo.header_offsetZipInfo.CRCZipInfo.compress_sizeZipInfo.file_size
- 12.4.4. Command-Line Interface
- 12.4.5. Decompression pitfalls
- 12.5.
tarfile— Read and write tar archive filesopen()TarFileis_tarfile()TarFileCompatTarErrorReadErrorCompressionErrorStreamErrorExtractErrorENCODINGHeaderErrorUSTAR_FORMATGNU_FORMATPAX_FORMATDEFAULT_FORMAT- 12.5.1. TarFile Objects
- 12.5.2. TarInfo Objects
TarInfoTarInfo.frombuf()TarInfo.fromtarfile()TarInfo.tobuf()TarInfo.nameTarInfo.sizeTarInfo.mtimeTarInfo.modeTarInfo.typeTarInfo.linknameTarInfo.uidTarInfo.gidTarInfo.unameTarInfo.gnameTarInfo.pax_headersTarInfo.isfile()TarInfo.isreg()TarInfo.isdir()TarInfo.issym()TarInfo.islnk()TarInfo.ischr()TarInfo.isblk()TarInfo.isfifo()TarInfo.isdev()
- 12.5.3. Examples
- 12.5.4. Supported tar formats
- 12.5.5. Unicode issues
- 12.1.
- 13. File Formats
- 13.1.
csv— CSV File Reading and Writing - 13.2.
ConfigParser— Configuration file parserRawConfigParserConfigParserSafeConfigParserErrorNoSectionErrorDuplicateSectionErrorNoOptionErrorInterpolationErrorInterpolationDepthErrorInterpolationMissingOptionErrorInterpolationSyntaxErrorMissingSectionHeaderErrorParsingErrorMAX_INTERPOLATION_DEPTH- 13.2.1. RawConfigParser Objects
RawConfigParser.defaults()RawConfigParser.sections()RawConfigParser.add_section()RawConfigParser.has_section()RawConfigParser.options()RawConfigParser.has_option()RawConfigParser.read()RawConfigParser.readfp()RawConfigParser.get()RawConfigParser.getint()RawConfigParser.getfloat()RawConfigParser.getboolean()RawConfigParser.items()RawConfigParser.set()RawConfigParser.write()RawConfigParser.remove_option()RawConfigParser.remove_section()RawConfigParser.optionxform()
- 13.2.2. ConfigParser Objects
- 13.2.3. SafeConfigParser Objects
- 13.2.4. Examples
- 13.3.
robotparser— Parser for robots.txt - 13.4.
netrc— netrc file processing - 13.5.
xdrlib— Encode and decode XDR dataPackerUnpacker- 13.5.1. Packer Objects
- 13.5.2. Unpacker Objects
Unpacker.reset()Unpacker.get_position()Unpacker.set_position()Unpacker.get_buffer()Unpacker.done()Unpacker.unpack_float()Unpacker.unpack_double()Unpacker.unpack_fstring()Unpacker.unpack_fopaque()Unpacker.unpack_string()Unpacker.unpack_opaque()Unpacker.unpack_bytes()Unpacker.unpack_list()Unpacker.unpack_farray()Unpacker.unpack_array()
- 13.5.3. Exceptions
- 13.6.
plistlib— Generate and parse Mac OS X.plistfiles
- 13.1.
- 14. Cryptographic Services
- 15. Generic Operating System Services
- 15.1.
os— Miscellaneous operating system interfaceserrorname- 15.1.1. Process Parameters
environctermid()getegid()geteuid()getgid()getgroups()initgroups()getlogin()getpgid()getpgrp()getpid()getppid()getresuid()getresgid()getuid()getenv()putenv()setegid()seteuid()setgid()setgroups()setpgrp()setpgid()setregid()setresgid()setresuid()setreuid()getsid()setsid()setuid()strerror()umask()uname()unsetenv()
- 15.1.2. File Object Creation
- 15.1.3. File Descriptor Operations
- 15.1.4. Files and Directories
access()F_OKR_OKW_OKX_OKchdir()fchdir()getcwd()getcwdu()chflags()chroot()chmod()chown()lchflags()lchmod()lchown()link()listdir()lstat()mkfifo()mknod()major()minor()makedev()mkdir()makedirs()pathconf()pathconf_namesreadlink()remove()removedirs()rename()renames()rmdir()stat()stat_float_times()statvfs()symlink()tempnam()tmpnam()TMP_MAXunlink()utime()walk()
- 15.1.5. Process Management
abort()execl()execle()execlp()execlpe()execv()execve()execvp()execvpe()_exit()EX_OKEX_USAGEEX_DATAERREX_NOINPUTEX_NOUSEREX_NOHOSTEX_UNAVAILABLEEX_SOFTWAREEX_OSERREX_OSFILEEX_CANTCREATEX_IOERREX_TEMPFAILEX_PROTOCOLEX_NOPERMEX_CONFIGEX_NOTFOUNDfork()forkpty()kill()killpg()nice()plock()spawnl()spawnle()spawnlp()spawnlpe()spawnv()spawnve()spawnvp()spawnvpe()P_NOWAITP_NOWAITOP_WAITP_DETACHP_OVERLAYstartfile()system()times()wait()waitpid()wait3()wait4()WNOHANGWCONTINUEDWUNTRACEDWCOREDUMP()WIFCONTINUED()WIFSTOPPED()WIFSIGNALED()WIFEXITED()WEXITSTATUS()WSTOPSIG()WTERMSIG()
- 15.1.6. Miscellaneous System Information
- 15.1.7. Miscellaneous Functions
- 15.2.
io— Core tools for working with streams - 15.3.
time— Time access and conversions - 15.4.
argparse— Parser for command-line options, arguments and sub-commands- 15.4.1. Example
- 15.4.2. ArgumentParser objects
- 15.4.3. The add_argument() method
- 15.4.4. The parse_args() method
- 15.4.5. Other utilities
- 15.4.6. Upgrading optparse code
- 15.5.
optparse— Parser for command line options- 15.5.1. Background
- 15.5.2. Tutorial
- 15.5.3. Reference Guide
- 15.5.3.1. Creating the parser
- 15.5.3.2. Populating the parser
- 15.5.3.3. Defining options
- 15.5.3.4. Option attributes
- 15.5.3.5. Standard option actions
- 15.5.3.6. Standard option types
- 15.5.3.7. Parsing arguments
- 15.5.3.8. Querying and manipulating your option parser
- 15.5.3.9. Conflicts between options
- 15.5.3.10. Cleanup
- 15.5.3.11. Other methods
- 15.5.4. Option Callbacks
- 15.5.4.1. Defining a callback option
- 15.5.4.2. How callbacks are called
- 15.5.4.3. Raising errors in a callback
- 15.5.4.4. Callback example 1: trivial callback
- 15.5.4.5. Callback example 2: check option order
- 15.5.4.6. Callback example 3: check option order (generalized)
- 15.5.4.7. Callback example 4: check arbitrary condition
- 15.5.4.8. Callback example 5: fixed arguments
- 15.5.4.9. Callback example 6: variable arguments
- 15.5.5. Extending
optparse
- 15.6.
getopt— C-style parser for command line options - 15.7.
logging— Logging facility for Python- 15.7.1. Logger Objects
LoggerLogger.propagateLogger.setLevel()Logger.isEnabledFor()Logger.getEffectiveLevel()Logger.getChild()Logger.debug()Logger.info()Logger.warning()Logger.error()Logger.critical()Logger.log()Logger.exception()Logger.addFilter()Logger.removeFilter()Logger.filter()Logger.addHandler()Logger.removeHandler()Logger.findCaller()Logger.handle()Logger.makeRecord()
- 15.7.2. Logging Levels
- 15.7.3. Handler Objects
- 15.7.4. Formatter Objects
- 15.7.5. Filter Objects
- 15.7.6. LogRecord Objects
- 15.7.7. LogRecord attributes
- 15.7.8. LoggerAdapter Objects
- 15.7.9. Thread Safety
- 15.7.10. Module-Level Functions
- 15.7.11. Integration with the warnings module
- 15.7.1. Logger Objects
- 15.8.
logging.config— Logging configuration - 15.9.
logging.handlers— Logging handlers- 15.9.1. StreamHandler
- 15.9.2. FileHandler
- 15.9.3. NullHandler
- 15.9.4. WatchedFileHandler
- 15.9.5. RotatingFileHandler
- 15.9.6. TimedRotatingFileHandler
- 15.9.7. SocketHandler
- 15.9.8. DatagramHandler
- 15.9.9. SysLogHandler
- 15.9.10. NTEventLogHandler
- 15.9.11. SMTPHandler
- 15.9.12. MemoryHandler
- 15.9.13. HTTPHandler
- 15.10.
getpass— Portable password input - 15.11.
curses— Terminal handling for character-cell displays- 15.11.1. Functions
errorbaudrate()beep()can_change_color()cbreak()color_content()color_pair()curs_set()def_prog_mode()def_shell_mode()delay_output()doupdate()echo()endwin()erasechar()filter()flash()flushinp()getmouse()getsyx()getwin()has_colors()has_ic()has_il()has_key()halfdelay()init_color()init_pair()initscr()is_term_resized()isendwin()keyname()killchar()longname()meta()mouseinterval()mousemask()napms()newpad()newwin()nl()nocbreak()noecho()nonl()noqiflush()noraw()pair_content()pair_number()putp()qiflush()raw()reset_prog_mode()reset_shell_mode()resetty()resize_term()resizeterm()savetty()setsyx()setupterm()start_color()termattrs()termname()tigetflag()tigetnum()tigetstr()tparm()typeahead()unctrl()ungetch()ungetmouse()use_env()use_default_colors()wrapper()
- 15.11.2. Window Objects
window.addch()window.addnstr()window.addstr()window.attroff()window.attron()window.attrset()window.bkgd()window.bkgdset()window.border()window.box()window.chgat()window.clear()window.clearok()window.clrtobot()window.clrtoeol()window.cursyncup()window.delch()window.deleteln()window.derwin()window.echochar()window.enclose()window.erase()window.getbegyx()window.getbkgd()window.getch()window.getkey()window.getmaxyx()window.getparyx()window.getstr()window.getyx()window.hline()window.idcok()window.idlok()window.immedok()window.inch()window.insch()window.insdelln()window.insertln()window.insnstr()window.insstr()window.instr()window.is_linetouched()window.is_wintouched()window.keypad()window.leaveok()window.move()window.mvderwin()window.mvwin()window.nodelay()window.notimeout()window.noutrefresh()window.overlay()window.overwrite()window.putwin()window.redrawln()window.redrawwin()window.refresh()window.resize()window.scroll()window.scrollok()window.setscrreg()window.standend()window.standout()window.subpad()window.subwin()window.syncdown()window.syncok()window.syncup()window.timeout()window.touchline()window.touchwin()window.untouchwin()window.vline()
- 15.11.3. Constants
- 15.11.1. Functions
- 15.12.
curses.textpad— Text input widget for curses programs - 15.13.
curses.ascii— Utilities for ASCII characters - 15.14.
curses.panel— A panel stack extension for curses - 15.15.
platform— Access to underlying platform’s identifying data - 15.16.
errno— Standard errno system symbolserrorcodeEPERMENOENTESRCHEINTREIOENXIOE2BIGENOEXECEBADFECHILDEAGAINENOMEMEACCESEFAULTENOTBLKEBUSYEEXISTEXDEVENODEVENOTDIREISDIREINVALENFILEEMFILEENOTTYETXTBSYEFBIGENOSPCESPIPEEROFSEMLINKEPIPEEDOMERANGEEDEADLKENAMETOOLONGENOLCKENOSYSENOTEMPTYELOOPEWOULDBLOCKENOMSGEIDRMECHRNGEL2NSYNCEL3HLTEL3RSTELNRNGEUNATCHENOCSIEL2HLTEBADEEBADREXFULLENOANOEBADRQCEBADSLTEDEADLOCKEBFONTENOSTRENODATAETIMEENOSRENONETENOPKGEREMOTEENOLINKEADVESRMNTECOMMEPROTOEMULTIHOPEDOTDOTEBADMSGEOVERFLOWENOTUNIQEBADFDEREMCHGELIBACCELIBBADELIBSCNELIBMAXELIBEXECEILSEQERESTARTESTRPIPEEUSERSENOTSOCKEDESTADDRREQEMSGSIZEEPROTOTYPEENOPROTOOPTEPROTONOSUPPORTESOCKTNOSUPPORTEOPNOTSUPPEPFNOSUPPORTEAFNOSUPPORTEADDRINUSEEADDRNOTAVAILENETDOWNENETUNREACHENETRESETECONNABORTEDECONNRESETENOBUFSEISCONNENOTCONNESHUTDOWNETOOMANYREFSETIMEDOUTECONNREFUSEDEHOSTDOWNEHOSTUNREACHEALREADYEINPROGRESSESTALEEUCLEANENOTNAMENAVAILEISNAMEREMOTEIOEDQUOT
- 15.17.
ctypes— A foreign function library for Python- 15.17.1. ctypes tutorial
- 15.17.1.1. Loading dynamic link libraries
- 15.17.1.2. Accessing functions from loaded dlls
- 15.17.1.3. Calling functions
- 15.17.1.4. Fundamental data types
- 15.17.1.5. Calling functions, continued
- 15.17.1.6. Calling functions with your own custom data types
- 15.17.1.7. Specifying the required argument types (function prototypes)
- 15.17.1.8. Return types
- 15.17.1.9. Passing pointers (or: passing parameters by reference)
- 15.17.1.10. Structures and unions
- 15.17.1.11. Structure/union alignment and byte order
- 15.17.1.12. Bit fields in structures and unions
- 15.17.1.13. Arrays
- 15.17.1.14. Pointers
- 15.17.1.15. Type conversions
- 15.17.1.16. Incomplete Types
- 15.17.1.17. Callback functions
- 15.17.1.18. Accessing values exported from dlls
- 15.17.1.19. Surprises
- 15.17.1.20. Variable-sized data types
- 15.17.2. ctypes reference
- 15.17.2.1. Finding shared libraries
- 15.17.2.2. Loading shared libraries
- 15.17.2.3. Foreign functions
- 15.17.2.4. Function prototypes
- 15.17.2.5. Utility functions
addressof()alignment()byref()cast()create_string_buffer()create_unicode_buffer()DllCanUnloadNow()DllGetClassObject()find_library()find_msvcrt()FormatError()GetLastError()get_errno()get_last_error()memmove()memset()POINTER()pointer()resize()set_conversion_mode()set_errno()set_last_error()sizeof()string_at()WinError()wstring_at()
- 15.17.2.6. Data types
- 15.17.2.7. Fundamental data types
- 15.17.2.8. Structured data types
- 15.17.2.9. Arrays and pointers
- 15.17.1. ctypes tutorial
- 15.1.
- 16. Optional Operating System Services
- 16.1.
select— Waiting for I/O completion - 16.2.
threading— Higher-level threading interfaceactive_count()activeCount()current_thread()currentThread()enumerate()localLock()RLock()BoundedSemaphore()settrace()setprofile()stack_size()ThreadError- 16.2.1. Thread Objects
- 16.2.2. Lock Objects
- 16.2.3. RLock Objects
- 16.2.4. Condition Objects
- 16.2.5. Semaphore Objects
- 16.2.6. Event Objects
- 16.2.7. Timer Objects
- 16.2.8. Using locks, conditions, and semaphores in the
withstatement - 16.2.9. Importing in threaded code
- 16.3.
thread— Multiple threads of control - 16.4.
dummy_threading— Drop-in replacement for thethreadingmodule - 16.5.
dummy_thread— Drop-in replacement for thethreadmodule - 16.6.
multiprocessing— Process-based “threading” interface- 16.6.1. Introduction
- 16.6.2. Reference
- 16.6.2.1.
Processand exceptions - 16.6.2.2. Pipes and Queues
- 16.6.2.3. Miscellaneous
- 16.6.2.4. Connection Objects
- 16.6.2.5. Synchronization primitives
- 16.6.2.6. Shared
ctypesObjects - 16.6.2.7. Managers
- 16.6.2.8. Proxy Objects
- 16.6.2.9. Process Pools
- 16.6.2.10. Listeners and Clients
- 16.6.2.11. Authentication keys
- 16.6.2.12. Logging
- 16.6.2.13. The
multiprocessing.dummymodule
- 16.6.2.1.
- 16.6.3. Programming guidelines
- 16.6.4. Examples
- 16.7.
mmap— Memory-mapped file support - 16.8.
readline— GNU readline interface - 16.9.
rlcompleter— Completion function for GNU readline
- 16.1.
- 17. Interprocess Communication and Networking
- 17.1.
subprocess— Subprocess management - 17.2.
socket— Low-level networking interfaceerrorherrorgaierrortimeoutAF_UNIXAF_INETAF_INET6SOCK_STREAMSOCK_DGRAMSOCK_RAWSOCK_RDMSOCK_SEQPACKETSOMAXCONNhas_ipv6create_connection()getaddrinfo()getfqdn()gethostbyname()gethostbyname_ex()gethostname()gethostbyaddr()getnameinfo()getprotobyname()getservbyname()getservbyport()socket()socketpair()fromfd()ntohl()ntohs()htonl()htons()inet_aton()inet_ntoa()inet_pton()inet_ntop()getdefaulttimeout()setdefaulttimeout()SocketType- 17.2.1. Socket Objects
socket.accept()socket.bind()socket.close()socket.connect()socket.connect_ex()socket.fileno()socket.getpeername()socket.getsockname()socket.getsockopt()socket.ioctl()socket.listen()socket.makefile()socket.recv()socket.recvfrom()socket.recvfrom_into()socket.recv_into()socket.send()socket.sendall()socket.sendto()socket.setblocking()socket.settimeout()socket.gettimeout()socket.setsockopt()socket.shutdown()socket.familysocket.typesocket.proto
- 17.2.2. Example
- 17.3.
ssl— TLS/SSL wrapper for socket objects- 17.3.1. Functions, Constants, and Exceptions
SSLErrorSSLZeroReturnErrorSSLWantReadErrorSSLWantWriteErrorSSLSyscallErrorSSLEOFErrorCertificateError- 17.3.1.1. Socket creation
- 17.3.1.2. Context creation
- 17.3.1.3. Random generation
- 17.3.1.4. Certificate handling
- 17.3.1.5. Constants
CERT_NONECERT_OPTIONALCERT_REQUIREDVERIFY_DEFAULTVERIFY_CRL_CHECK_LEAFVERIFY_CRL_CHECK_CHAINVERIFY_X509_STRICTVERIFY_X509_TRUSTED_FIRSTPROTOCOL_TLSPROTOCOL_SSLv23PROTOCOL_SSLv2PROTOCOL_SSLv3PROTOCOL_TLSv1PROTOCOL_TLSv1_1PROTOCOL_TLSv1_2OP_ALLOP_NO_SSLv2OP_NO_SSLv3OP_NO_TLSv1OP_NO_TLSv1_1OP_NO_TLSv1_2OP_NO_TLSv1_3OP_CIPHER_SERVER_PREFERENCEOP_SINGLE_DH_USEOP_SINGLE_ECDH_USEOP_ENABLE_MIDDLEBOX_COMPATOP_NO_COMPRESSIONHAS_ALPNHAS_ECDHHAS_SNIHAS_NPNHAS_TLSv1_3CHANNEL_BINDING_TYPESOPENSSL_VERSIONOPENSSL_VERSION_INFOOPENSSL_VERSION_NUMBERALERT_DESCRIPTION_HANDSHAKE_FAILUREALERT_DESCRIPTION_INTERNAL_ERRORPurpose.SERVER_AUTHPurpose.CLIENT_AUTH
- 17.3.2. SSL Sockets
- 17.3.3. SSL Contexts
SSLContextSSLContext.cert_store_stats()SSLContext.load_cert_chain()SSLContext.load_default_certs()SSLContext.load_verify_locations()SSLContext.get_ca_certs()SSLContext.set_default_verify_paths()SSLContext.set_ciphers()SSLContext.set_alpn_protocols()SSLContext.set_npn_protocols()SSLContext.set_servername_callback()SSLContext.load_dh_params()SSLContext.set_ecdh_curve()SSLContext.wrap_socket()SSLContext.session_stats()SSLContext.check_hostnameSSLContext.optionsSSLContext.protocolSSLContext.verify_flagsSSLContext.verify_mode
- 17.3.4. Certificates
- 17.3.5. Examples
- 17.3.6. Notes on non-blocking sockets
- 17.3.7. Security considerations
- 17.3.8. LibreSSL support
- 17.3.1. Functions, Constants, and Exceptions
- 17.4.
signal— Set handlers for asynchronous events - 17.5.
popen2— Subprocesses with accessible I/O streams - 17.6.
asyncore— Asynchronous socket handlerloop()dispatcherdispatcher.handle_read()dispatcher.handle_write()dispatcher.handle_expt()dispatcher.handle_connect()dispatcher.handle_close()dispatcher.handle_error()dispatcher.handle_accept()dispatcher.readable()dispatcher.writable()dispatcher.create_socket()dispatcher.connect()dispatcher.send()dispatcher.recv()dispatcher.listen()dispatcher.bind()dispatcher.accept()dispatcher.close()
dispatcher_with_sendfile_dispatcherfile_wrapper- 17.6.1. asyncore Example basic HTTP client
- 17.6.2. asyncore Example basic echo server
- 17.7.
asynchat— Asynchronous socket command/response handlerasync_chatasync_chat.close_when_done()async_chat.collect_incoming_data()async_chat.discard_buffers()async_chat.found_terminator()async_chat.get_terminator()async_chat.push()async_chat.push_with_producer()async_chat.set_terminator()- 17.7.1. asynchat - Auxiliary Classes
- 17.7.2. asynchat Example
- 17.1.
- 18. Internet Data Handling
- 18.1.
email— An email and MIME handling package- 18.1.1.
email.message: Representing an email messageMessageMessage.as_string()Message.__str__()Message.is_multipart()Message.set_unixfrom()Message.get_unixfrom()Message.attach()Message.get_payload()Message.set_payload()Message.set_charset()Message.get_charset()Message.__len__()Message.__contains__()Message.__getitem__()Message.__setitem__()Message.__delitem__()Message.has_key()Message.keys()Message.values()Message.items()Message.get()Message.get_all()Message.add_header()Message.replace_header()Message.get_content_type()Message.get_content_maintype()Message.get_content_subtype()Message.get_default_type()Message.set_default_type()Message.get_params()Message.get_param()Message.set_param()Message.del_param()Message.set_type()Message.get_filename()Message.get_boundary()Message.set_boundary()Message.get_content_charset()Message.get_charsets()Message.walk()Message.preambleMessage.epilogueMessage.defects
- 18.1.2.
email.parser: Parsing email messages - 18.1.3.
email.generator: Generating MIME documents - 18.1.4.
email.mime: Creating email and MIME objects from scratch - 18.1.5.
email.header: Internationalized headers - 18.1.6.
email.charset: Representing character setsCharsetCharset.input_charsetCharset.header_encodingCharset.body_encodingCharset.output_charsetCharset.input_codecCharset.output_codecCharset.get_body_encoding()Charset.convert()Charset.to_splittable()Charset.from_splittable()Charset.get_output_charset()Charset.encoded_header_len()Charset.header_encode()Charset.body_encode()Charset.__str__()Charset.__eq__()Charset.__ne__()
add_charset()add_alias()add_codec()
- 18.1.7.
email.encoders: Encoders - 18.1.8.
email.errors: Exception and Defect classes - 18.1.9.
email.utils: Miscellaneous utilities - 18.1.10.
email.iterators: Iterators - 18.1.11.
email: Examples - 18.1.12. Package History
- 18.1.13. Differences from
mimelib
- 18.1.1.
- 18.2.
json— JSON encoder and decoder - 18.3.
mailcap— Mailcap file handling - 18.4.
mailbox— Manipulate mailboxes in various formats- 18.4.1.
MailboxobjectsMailboxMailbox.add()Mailbox.remove()Mailbox.__delitem__()Mailbox.discard()Mailbox.__setitem__()Mailbox.iterkeys()Mailbox.keys()Mailbox.itervalues()Mailbox.__iter__()Mailbox.values()Mailbox.iteritems()Mailbox.items()Mailbox.get()Mailbox.__getitem__()Mailbox.get_message()Mailbox.get_string()Mailbox.get_file()Mailbox.has_key()Mailbox.__contains__()Mailbox.__len__()Mailbox.clear()Mailbox.pop()Mailbox.popitem()Mailbox.update()Mailbox.flush()Mailbox.lock()Mailbox.unlock()Mailbox.close()
- 18.4.1.1.
Maildir - 18.4.1.2.
mbox - 18.4.1.3.
MH - 18.4.1.4.
Babyl - 18.4.1.5.
MMDF
- 18.4.2.
Messageobjects - 18.4.3. Exceptions
- 18.4.4. Deprecated classes and methods
- 18.4.5. Examples
- 18.4.1.
- 18.5.
mhlib— Access to MH mailboxesMHFolderMessage- 18.5.1. MH Objects
- 18.5.2. Folder Objects
Folder.error()Folder.getfullname()Folder.getsequencesfilename()Folder.getmessagefilename()Folder.listmessages()Folder.getcurrent()Folder.setcurrent()Folder.parsesequence()Folder.getlast()Folder.setlast()Folder.getsequences()Folder.putsequences()Folder.removemessages()Folder.refilemessages()Folder.movemessage()Folder.copymessage()
- 18.5.3. Message Objects
- 18.6.
mimetools— Tools for parsing MIME messages - 18.7.
mimetypes— Map filenames to MIME types - 18.8.
MimeWriter— Generic MIME file writer - 18.9.
mimify— MIME processing of mail messages - 18.10.
multifile— Support for files containing distinct parts - 18.11.
rfc822— Parse RFC 2822 mail headersMessageAddressListquote()unquote()parseaddr()dump_address_pair()parsedate()parsedate_tz()mktime_tz()- 18.11.1. Message Objects
Message.rewindbody()Message.isheader()Message.islast()Message.iscomment()Message.getallmatchingheaders()Message.getfirstmatchingheader()Message.getrawheader()Message.getheader()Message.get()Message.getaddr()Message.getaddrlist()Message.getdate()Message.getdate_tz()Message.headersMessage.fpMessage.unixfrom
- 18.11.2. AddressList Objects
- 18.12.
base64— RFC 3548: Base16, Base32, Base64 Data Encodings - 18.13.
binhex— Encode and decode binhex4 files - 18.14.
binascii— Convert between binary and ASCII - 18.15.
quopri— Encode and decode MIME quoted-printable data - 18.16.
uu— Encode and decode uuencode files
- 18.1.
- 19. Structured Markup Processing Tools
- 19.1.
HTMLParser— Simple HTML and XHTML parserHTMLParserHTMLParseError- 19.1.1. Example HTML Parser Application
- 19.1.2.
HTMLParserMethodsHTMLParser.feed()HTMLParser.close()HTMLParser.reset()HTMLParser.getpos()HTMLParser.get_starttag_text()HTMLParser.handle_starttag()HTMLParser.handle_endtag()HTMLParser.handle_startendtag()HTMLParser.handle_data()HTMLParser.handle_entityref()HTMLParser.handle_charref()HTMLParser.handle_comment()HTMLParser.handle_decl()HTMLParser.handle_pi()HTMLParser.unknown_decl()
- 19.1.3. Examples
- 19.2.
sgmllib— Simple SGML parserSGMLParserSGMLParseErrorSGMLParser.reset()SGMLParser.setnomoretags()SGMLParser.setliteral()SGMLParser.feed()SGMLParser.close()SGMLParser.get_starttag_text()SGMLParser.handle_starttag()SGMLParser.handle_endtag()SGMLParser.handle_data()SGMLParser.handle_charref()SGMLParser.convert_charref()SGMLParser.convert_codepoint()SGMLParser.handle_entityref()SGMLParser.convert_entityref()SGMLParser.handle_comment()SGMLParser.handle_decl()SGMLParser.report_unbalanced()SGMLParser.unknown_starttag()SGMLParser.unknown_endtag()SGMLParser.unknown_charref()SGMLParser.unknown_entityref()
- 19.3.
htmllib— A parser for HTML documents - 19.4.
htmlentitydefs— Definitions of HTML general entities - 19.5. XML Processing Modules
- 19.6. XML vulnerabilities
- 19.7.
xml.etree.ElementTree— The ElementTree XML API- 19.7.1. Tutorial
- 19.7.2. XPath support
- 19.7.3. Reference
- 19.7.3.1. Functions
- 19.7.3.2. Element Objects
ElementElement.tagElement.textElement.tailElement.attribElement.clear()Element.get()Element.items()Element.keys()Element.set()Element.append()Element.extend()Element.find()Element.findall()Element.findtext()Element.getchildren()Element.getiterator()Element.insert()Element.iter()Element.iterfind()Element.itertext()Element.makeelement()Element.remove()
- 19.7.3.3. ElementTree Objects
- 19.7.3.4. QName Objects
- 19.7.3.5. TreeBuilder Objects
- 19.7.3.6. XMLParser Objects
- 19.8.
xml.dom— The Document Object Model API- 19.8.1. Module Contents
- 19.8.2. Objects in the DOM
- 19.8.2.1. DOMImplementation Objects
- 19.8.2.2. Node Objects
Node.nodeTypeNode.parentNodeNode.attributesNode.previousSiblingNode.nextSiblingNode.childNodesNode.firstChildNode.lastChildNode.localNameNode.prefixNode.namespaceURINode.nodeNameNode.nodeValueNode.hasAttributes()Node.hasChildNodes()Node.isSameNode()Node.appendChild()Node.insertBefore()Node.removeChild()Node.replaceChild()Node.normalize()Node.cloneNode()
- 19.8.2.3. NodeList Objects
- 19.8.2.4. DocumentType Objects
- 19.8.2.5. Document Objects
- 19.8.2.6. Element Objects
Element.tagNameElement.getElementsByTagName()Element.getElementsByTagNameNS()Element.hasAttribute()Element.hasAttributeNS()Element.getAttribute()Element.getAttributeNode()Element.getAttributeNS()Element.getAttributeNodeNS()Element.removeAttribute()Element.removeAttributeNode()Element.removeAttributeNS()Element.setAttribute()Element.setAttributeNode()Element.setAttributeNodeNS()Element.setAttributeNS()
- 19.8.2.7. Attr Objects
- 19.8.2.8. NamedNodeMap Objects
- 19.8.2.9. Comment Objects
- 19.8.2.10. Text and CDATASection Objects
- 19.8.2.11. ProcessingInstruction Objects
- 19.8.2.12. Exceptions
- 19.8.3. Conformance
- 19.9.
xml.dom.minidom— Minimal DOM implementation - 19.10.
xml.dom.pulldom— Support for building partial DOM trees - 19.11.
xml.sax— Support for SAX2 parsers - 19.12.
xml.sax.handler— Base classes for SAX handlersContentHandlerDTDHandlerEntityResolverErrorHandlerfeature_namespacesfeature_namespace_prefixesfeature_string_interningfeature_validationfeature_external_gesfeature_external_pesall_featuresproperty_lexical_handlerproperty_declaration_handlerproperty_dom_nodeproperty_xml_stringall_properties- 19.12.1. ContentHandler Objects
ContentHandler.setDocumentLocator()ContentHandler.startDocument()ContentHandler.endDocument()ContentHandler.startPrefixMapping()ContentHandler.endPrefixMapping()ContentHandler.startElement()ContentHandler.endElement()ContentHandler.startElementNS()ContentHandler.endElementNS()ContentHandler.characters()ContentHandler.ignorableWhitespace()ContentHandler.processingInstruction()ContentHandler.skippedEntity()
- 19.12.2. DTDHandler Objects
- 19.12.3. EntityResolver Objects
- 19.12.4. ErrorHandler Objects
- 19.13.
xml.sax.saxutils— SAX Utilities - 19.14.
xml.sax.xmlreader— Interface for XML parsersXMLReaderIncrementalParserLocatorInputSourceAttributesImplAttributesNSImpl- 19.14.1. XMLReader Objects
XMLReader.parse()XMLReader.getContentHandler()XMLReader.setContentHandler()XMLReader.getDTDHandler()XMLReader.setDTDHandler()XMLReader.getEntityResolver()XMLReader.setEntityResolver()XMLReader.getErrorHandler()XMLReader.setErrorHandler()XMLReader.setLocale()XMLReader.getFeature()XMLReader.setFeature()XMLReader.getProperty()XMLReader.setProperty()
- 19.14.2. IncrementalParser Objects
- 19.14.3. Locator Objects
- 19.14.4. InputSource Objects
- 19.14.5. The
AttributesInterface - 19.14.6. The
AttributesNSInterface
- 19.15.
xml.parsers.expat— Fast XML parsing using ExpatExpatErrorerrorXMLParserTypeErrorString()ParserCreate()- 19.15.1. XMLParser Objects
xmlparser.Parse()xmlparser.ParseFile()xmlparser.SetBase()xmlparser.GetBase()xmlparser.GetInputContext()xmlparser.ExternalEntityParserCreate()xmlparser.SetParamEntityParsing()xmlparser.UseForeignDTD()xmlparser.buffer_sizexmlparser.buffer_textxmlparser.buffer_usedxmlparser.ordered_attributesxmlparser.returns_unicodexmlparser.specified_attributesxmlparser.ErrorByteIndexxmlparser.ErrorCodexmlparser.ErrorColumnNumberxmlparser.ErrorLineNumberxmlparser.CurrentByteIndexxmlparser.CurrentColumnNumberxmlparser.CurrentLineNumberxmlparser.XmlDeclHandler()xmlparser.StartDoctypeDeclHandler()xmlparser.EndDoctypeDeclHandler()xmlparser.ElementDeclHandler()xmlparser.AttlistDeclHandler()xmlparser.StartElementHandler()xmlparser.EndElementHandler()xmlparser.ProcessingInstructionHandler()xmlparser.CharacterDataHandler()xmlparser.UnparsedEntityDeclHandler()xmlparser.EntityDeclHandler()xmlparser.NotationDeclHandler()xmlparser.StartNamespaceDeclHandler()xmlparser.EndNamespaceDeclHandler()xmlparser.CommentHandler()xmlparser.StartCdataSectionHandler()xmlparser.EndCdataSectionHandler()xmlparser.DefaultHandler()xmlparser.DefaultHandlerExpand()xmlparser.NotStandaloneHandler()xmlparser.ExternalEntityRefHandler()
- 19.15.2. ExpatError Exceptions
- 19.15.3. Example
- 19.15.4. Content Model Descriptions
- 19.15.5. Expat error constants
- 19.1.
- 20. Internet Protocols and Support
- 20.1.
webbrowser— Convenient Web-browser controller - 20.2.
cgi— Common Gateway Interface support- 20.2.1. Introduction
- 20.2.2. Using the cgi module
- 20.2.3. Higher Level Interface
- 20.2.4. Old classes
- 20.2.5. Functions
- 20.2.6. Caring about security
- 20.2.7. Installing your CGI script on a Unix system
- 20.2.8. Testing your CGI script
- 20.2.9. Debugging CGI scripts
- 20.2.10. Common problems and solutions
- 20.3.
cgitb— Traceback manager for CGI scripts - 20.4.
wsgiref— WSGI Utilities and Reference Implementation- 20.4.1.
wsgiref.util– WSGI environment utilities - 20.4.2.
wsgiref.headers– WSGI response header tools - 20.4.3.
wsgiref.simple_server– a simple WSGI HTTP server - 20.4.4.
wsgiref.validate— WSGI conformance checker - 20.4.5.
wsgiref.handlers– server/gateway base classesCGIHandlerBaseCGIHandlerSimpleHandlerBaseHandlerBaseHandler.run()BaseHandler._write()BaseHandler._flush()BaseHandler.get_stdin()BaseHandler.get_stderr()BaseHandler.add_cgi_vars()BaseHandler.wsgi_multithreadBaseHandler.wsgi_multiprocessBaseHandler.wsgi_run_onceBaseHandler.os_environBaseHandler.server_softwareBaseHandler.get_scheme()BaseHandler.setup_environ()BaseHandler.log_exception()BaseHandler.traceback_limitBaseHandler.error_output()BaseHandler.error_statusBaseHandler.error_headersBaseHandler.error_bodyBaseHandler.wsgi_file_wrapperBaseHandler.sendfile()BaseHandler.origin_serverBaseHandler.http_version
- 20.4.6. Examples
- 20.4.1.
- 20.5.
urllib— Open arbitrary resources by URL - 20.6.
urllib2— extensible library for opening URLsurlopen()install_opener()build_opener()URLErrorHTTPErrorRequestOpenerDirectorBaseHandlerHTTPDefaultErrorHandlerHTTPRedirectHandlerHTTPCookieProcessorProxyHandlerHTTPPasswordMgrHTTPPasswordMgrWithDefaultRealmAbstractBasicAuthHandlerHTTPBasicAuthHandlerProxyBasicAuthHandlerAbstractDigestAuthHandlerHTTPDigestAuthHandlerProxyDigestAuthHandlerHTTPHandlerHTTPSHandlerFileHandlerFTPHandlerCacheFTPHandlerUnknownHandlerHTTPErrorProcessor- 20.6.1. Request Objects
Request.add_data()Request.get_method()Request.has_data()Request.get_data()Request.add_header()Request.add_unredirected_header()Request.has_header()Request.get_full_url()Request.get_type()Request.get_host()Request.get_selector()Request.get_header()Request.header_items()Request.set_proxy()Request.get_origin_req_host()Request.is_unverifiable()
- 20.6.2. OpenerDirector Objects
- 20.6.3. BaseHandler Objects
- 20.6.4. HTTPRedirectHandler Objects
- 20.6.5. HTTPCookieProcessor Objects
- 20.6.6. ProxyHandler Objects
- 20.6.7. HTTPPasswordMgr Objects
- 20.6.8. AbstractBasicAuthHandler Objects
- 20.6.9. HTTPBasicAuthHandler Objects
- 20.6.10. ProxyBasicAuthHandler Objects
- 20.6.11. AbstractDigestAuthHandler Objects
- 20.6.12. HTTPDigestAuthHandler Objects
- 20.6.13. ProxyDigestAuthHandler Objects
- 20.6.14. HTTPHandler Objects
- 20.6.15. HTTPSHandler Objects
- 20.6.16. FileHandler Objects
- 20.6.17. FTPHandler Objects
- 20.6.18. CacheFTPHandler Objects
- 20.6.19. UnknownHandler Objects
- 20.6.20. HTTPErrorProcessor Objects
- 20.6.21. Examples
- 20.7.
httplib— HTTP protocol clientHTTPConnectionHTTPSConnectionHTTPResponseHTTPMessageHTTPExceptionNotConnectedInvalidURLUnknownProtocolUnknownTransferEncodingUnimplementedFileModeIncompleteReadImproperConnectionStateCannotSendRequestCannotSendHeaderResponseNotReadyBadStatusLineHTTP_PORTHTTPS_PORTresponses- 20.7.1. HTTPConnection Objects
- 20.7.2. HTTPResponse Objects
- 20.7.3. Examples
- 20.8.
ftplib— FTP protocol clientFTPFTP_TLSerror_replyerror_temperror_permerror_protoall_errors- 20.8.1. FTP Objects
FTP.set_debuglevel()FTP.connect()FTP.getwelcome()FTP.login()FTP.abort()FTP.sendcmd()FTP.voidcmd()FTP.retrbinary()FTP.retrlines()FTP.set_pasv()FTP.storbinary()FTP.storlines()FTP.transfercmd()FTP.ntransfercmd()FTP.nlst()FTP.dir()FTP.rename()FTP.delete()FTP.cwd()FTP.mkd()FTP.pwd()FTP.rmd()FTP.size()FTP.quit()FTP.close()
- 20.8.2. FTP_TLS Objects
- 20.9.
poplib— POP3 protocol client - 20.10.
imaplib— IMAP4 protocol clientIMAP4IMAP4.errorIMAP4.abortIMAP4.readonlyIMAP4_SSLIMAP4_streamInternaldate2tuple()Int2AP()ParseFlags()Time2Internaldate()- 20.10.1. IMAP4 Objects
IMAP4.append()IMAP4.authenticate()IMAP4.check()IMAP4.close()IMAP4.copy()IMAP4.create()IMAP4.delete()IMAP4.deleteacl()IMAP4.expunge()IMAP4.fetch()IMAP4.getacl()IMAP4.getannotation()IMAP4.getquota()IMAP4.getquotaroot()IMAP4.list()IMAP4.login()IMAP4.login_cram_md5()IMAP4.logout()IMAP4.lsub()IMAP4.myrights()IMAP4.namespace()IMAP4.noop()IMAP4.open()IMAP4.partial()IMAP4.proxyauth()IMAP4.read()IMAP4.readline()IMAP4.recent()IMAP4.rename()IMAP4.response()IMAP4.search()IMAP4.select()IMAP4.send()IMAP4.setacl()IMAP4.setannotation()IMAP4.setquota()IMAP4.shutdown()IMAP4.socket()IMAP4.sort()IMAP4.status()IMAP4.store()IMAP4.subscribe()IMAP4.thread()IMAP4.uid()IMAP4.unsubscribe()IMAP4.xatom()IMAP4_SSL.ssl()IMAP4.PROTOCOL_VERSIONIMAP4.debug
- 20.10.2. IMAP4 Example
- 20.11.
nntplib— NNTP protocol clientNNTPNNTPErrorNNTPReplyErrorNNTPTemporaryErrorNNTPPermanentErrorNNTPProtocolErrorNNTPDataError- 20.11.1. NNTP Objects
NNTP.getwelcome()NNTP.set_debuglevel()NNTP.newgroups()NNTP.newnews()NNTP.list()NNTP.descriptions()NNTP.description()NNTP.group()NNTP.help()NNTP.stat()NNTP.next()NNTP.last()NNTP.head()NNTP.body()NNTP.article()NNTP.slave()NNTP.xhdr()NNTP.post()NNTP.ihave()NNTP.date()NNTP.xgtitle()NNTP.xover()NNTP.xpath()NNTP.quit()
- 20.12.
smtplib— SMTP protocol client - 20.13.
smtpd— SMTP Server - 20.14.
telnetlib— Telnet clientTelnet- 20.14.1. Telnet Objects
Telnet.read_until()Telnet.read_all()Telnet.read_some()Telnet.read_very_eager()Telnet.read_eager()Telnet.read_lazy()Telnet.read_very_lazy()Telnet.read_sb_data()Telnet.open()Telnet.msg()Telnet.set_debuglevel()Telnet.close()Telnet.get_socket()Telnet.fileno()Telnet.write()Telnet.interact()Telnet.mt_interact()Telnet.expect()Telnet.set_option_negotiation_callback()
- 20.14.2. Telnet Example
- 20.15.
uuid— UUID objects according to RFC 4122 - 20.16.
urlparse— Parse URLs into components - 20.17.
SocketServer— A framework for network serversTCPServerUDPServerUnixStreamServerUnixDatagramServer- 20.17.1. Server Creation Notes
- 20.17.2. Server Objects
BaseServerBaseServer.fileno()BaseServer.handle_request()BaseServer.serve_forever()BaseServer.shutdown()BaseServer.server_close()BaseServer.address_familyBaseServer.RequestHandlerClassBaseServer.server_addressBaseServer.socketBaseServer.allow_reuse_addressBaseServer.request_queue_sizeBaseServer.socket_typeBaseServer.timeoutBaseServer.finish_request()BaseServer.get_request()BaseServer.handle_error()BaseServer.handle_timeout()BaseServer.process_request()BaseServer.server_activate()BaseServer.server_bind()BaseServer.verify_request()
- 20.17.3. Request Handler Objects
- 20.17.4. Examples
- 20.18.
BaseHTTPServer— Basic HTTP serverHTTPServerBaseHTTPRequestHandlerBaseHTTPRequestHandler.client_addressBaseHTTPRequestHandler.serverBaseHTTPRequestHandler.commandBaseHTTPRequestHandler.pathBaseHTTPRequestHandler.request_versionBaseHTTPRequestHandler.headersBaseHTTPRequestHandler.rfileBaseHTTPRequestHandler.wfileBaseHTTPRequestHandler.server_versionBaseHTTPRequestHandler.sys_versionBaseHTTPRequestHandler.error_message_formatBaseHTTPRequestHandler.error_content_typeBaseHTTPRequestHandler.protocol_versionBaseHTTPRequestHandler.MessageClassBaseHTTPRequestHandler.responsesBaseHTTPRequestHandler.handle()BaseHTTPRequestHandler.handle_one_request()BaseHTTPRequestHandler.send_error()BaseHTTPRequestHandler.send_response()BaseHTTPRequestHandler.send_header()BaseHTTPRequestHandler.end_headers()BaseHTTPRequestHandler.log_request()BaseHTTPRequestHandler.log_error()BaseHTTPRequestHandler.log_message()BaseHTTPRequestHandler.version_string()BaseHTTPRequestHandler.date_time_string()BaseHTTPRequestHandler.log_date_time_string()BaseHTTPRequestHandler.address_string()
- 20.18.1. More examples
- 20.19.
SimpleHTTPServer— Simple HTTP request handler - 20.20.
CGIHTTPServer— CGI-capable HTTP request handler - 20.21.
cookielib— Cookie handling for HTTP clientsLoadErrorCookieJarFileCookieJarCookiePolicyDefaultCookiePolicyCookie- 20.21.1. CookieJar and FileCookieJar Objects
CookieJar.add_cookie_header()CookieJar.extract_cookies()CookieJar.set_policy()CookieJar.make_cookies()CookieJar.set_cookie_if_ok()CookieJar.set_cookie()CookieJar.clear()CookieJar.clear_session_cookies()FileCookieJar.save()FileCookieJar.load()FileCookieJar.revert()FileCookieJar.filenameFileCookieJar.delayload
- 20.21.2. FileCookieJar subclasses and co-operation with web browsers
- 20.21.3. CookiePolicy Objects
- 20.21.4. DefaultCookiePolicy Objects
DefaultCookiePolicy.blocked_domains()DefaultCookiePolicy.set_blocked_domains()DefaultCookiePolicy.is_blocked()DefaultCookiePolicy.allowed_domains()DefaultCookiePolicy.set_allowed_domains()DefaultCookiePolicy.is_not_allowed()DefaultCookiePolicy.rfc2109_as_netscapeDefaultCookiePolicy.strict_domainDefaultCookiePolicy.strict_rfc2965_unverifiableDefaultCookiePolicy.strict_ns_unverifiableDefaultCookiePolicy.strict_ns_domainDefaultCookiePolicy.strict_ns_set_initial_dollarDefaultCookiePolicy.strict_ns_set_pathDefaultCookiePolicy.DomainStrictNoDotsDefaultCookiePolicy.DomainStrictNonDomainDefaultCookiePolicy.DomainRFC2965MatchDefaultCookiePolicy.DomainLiberalDefaultCookiePolicy.DomainStrict
- 20.21.5. Cookie Objects
Cookie.versionCookie.nameCookie.valueCookie.portCookie.pathCookie.secureCookie.expiresCookie.discardCookie.commentCookie.comment_urlCookie.rfc2109Cookie.port_specifiedCookie.domain_specifiedCookie.domain_initial_dotCookie.has_nonstandard_attr()Cookie.get_nonstandard_attr()Cookie.set_nonstandard_attr()Cookie.is_expired()
- 20.21.6. Examples
- 20.22.
Cookie— HTTP state management - 20.23.
xmlrpclib— XML-RPC client accessServerProxy- 20.23.1. ServerProxy Objects
- 20.23.2. Boolean Objects
- 20.23.3. DateTime Objects
- 20.23.4. Binary Objects
- 20.23.5. Fault Objects
- 20.23.6. ProtocolError Objects
- 20.23.7. MultiCall Objects
- 20.23.8. Convenience Functions
- 20.23.9. Example of Client Usage
- 20.23.10. Example of Client and Server Usage
- 20.24.
SimpleXMLRPCServer— Basic XML-RPC serverSimpleXMLRPCServerCGIXMLRPCRequestHandlerSimpleXMLRPCRequestHandler- 20.24.1. SimpleXMLRPCServer Objects
SimpleXMLRPCServer.register_function()SimpleXMLRPCServer.register_instance()SimpleXMLRPCServer.register_introspection_functions()SimpleXMLRPCServer.register_multicall_functions()SimpleXMLRPCRequestHandler.rpc_pathsSimpleXMLRPCRequestHandler.encode_threshold- 20.24.1.1. SimpleXMLRPCServer Example
- 20.24.2. CGIXMLRPCRequestHandler
- 20.25.
DocXMLRPCServer— Self-documenting XML-RPC server
- 20.1.
- 21. Multimedia Services
- 21.1.
audioop— Manipulate raw audio data - 21.2.
imageop— Manipulate raw image data - 21.3.
aifc— Read and write AIFF and AIFC filesopen()aifc.getnchannels()aifc.getsampwidth()aifc.getframerate()aifc.getnframes()aifc.getcomptype()aifc.getcompname()aifc.getparams()aifc.getmarkers()aifc.getmark()aifc.readframes()aifc.rewind()aifc.setpos()aifc.tell()aifc.close()aifc.aiff()aifc.aifc()aifc.setnchannels()aifc.setsampwidth()aifc.setframerate()aifc.setnframes()aifc.setcomptype()aifc.setparams()aifc.setmark()aifc.tell()aifc.writeframes()aifc.writeframesraw()aifc.close()
- 21.4.
sunau— Read and write Sun AU filesopen()openfp()ErrorAUDIO_FILE_MAGICAUDIO_FILE_ENCODING_MULAW_8AUDIO_FILE_ENCODING_LINEAR_8AUDIO_FILE_ENCODING_LINEAR_16AUDIO_FILE_ENCODING_LINEAR_24AUDIO_FILE_ENCODING_LINEAR_32AUDIO_FILE_ENCODING_ALAW_8AUDIO_FILE_ENCODING_FLOATAUDIO_FILE_ENCODING_DOUBLEAUDIO_FILE_ENCODING_ADPCM_G721AUDIO_FILE_ENCODING_ADPCM_G722AUDIO_FILE_ENCODING_ADPCM_G723_3AUDIO_FILE_ENCODING_ADPCM_G723_5- 21.4.1. AU_read Objects
- 21.4.2. AU_write Objects
- 21.5.
wave— Read and write WAV filesopen()openfp()Error- 21.5.1. Wave_read Objects
Wave_read.close()Wave_read.getnchannels()Wave_read.getsampwidth()Wave_read.getframerate()Wave_read.getnframes()Wave_read.getcomptype()Wave_read.getcompname()Wave_read.getparams()Wave_read.readframes()Wave_read.rewind()Wave_read.getmarkers()Wave_read.getmark()Wave_read.setpos()Wave_read.tell()
- 21.5.2. Wave_write Objects
- 21.6.
chunk— Read IFF chunked data - 21.7.
colorsys— Conversions between color systems - 21.8.
imghdr— Determine the type of an image - 21.9.
sndhdr— Determine type of sound file - 21.10.
ossaudiodev— Access to OSS-compatible audio devicesOSSAudioErroropen()openmixer()- 21.10.1. Audio Device Objects
oss_audio_device.close()oss_audio_device.fileno()oss_audio_device.read()oss_audio_device.write()oss_audio_device.writeall()oss_audio_device.nonblock()oss_audio_device.getfmts()oss_audio_device.setfmt()oss_audio_device.channels()oss_audio_device.speed()oss_audio_device.sync()oss_audio_device.reset()oss_audio_device.post()oss_audio_device.setparameters()oss_audio_device.bufsize()oss_audio_device.obufcount()oss_audio_device.obuffree()oss_audio_device.closedoss_audio_device.nameoss_audio_device.mode
- 21.10.2. Mixer Device Objects
- 21.1.
- 22. Internationalization
- 22.1.
gettext— Multilingual internationalization services- 22.1.1. GNU gettext API
- 22.1.2. Class-based API
find()translation()install()- 22.1.2.1. The
NullTranslationsclassNullTranslationsNullTranslations._parse()NullTranslations.add_fallback()NullTranslations.gettext()NullTranslations.lgettext()NullTranslations.ugettext()NullTranslations.ngettext()NullTranslations.lngettext()NullTranslations.ungettext()NullTranslations.info()NullTranslations.charset()NullTranslations.output_charset()NullTranslations.set_output_charset()NullTranslations.install()
- 22.1.2.2. The
GNUTranslationsclass - 22.1.2.3. Solaris message catalog support
- 22.1.2.4. The Catalog constructor
- 22.1.3. Internationalizing your programs and modules
- 22.1.4. Acknowledgements
- 22.2.
locale— Internationalization servicesErrorsetlocale()localeconv()nl_langinfo()getdefaultlocale()getlocale()getpreferredencoding()normalize()resetlocale()strcoll()strxfrm()format()format_string()currency()str()atof()atoi()LC_CTYPELC_COLLATELC_TIMELC_MONETARYLC_MESSAGESLC_NUMERICLC_ALLCHAR_MAX- 22.2.1. Background, details, hints, tips and caveats
- 22.2.2. For extension writers and programs that embed Python
- 22.2.3. Access to message catalogs
- 22.1.
- 23. Program Frameworks
- 23.1.
cmd— Support for line-oriented command interpreters - 23.2.
shlex— Simple lexical analysissplit()shlex- 23.2.1. shlex Objects
shlex.get_token()shlex.push_token()shlex.read_token()shlex.sourcehook()shlex.push_source()shlex.pop_source()shlex.error_leader()shlex.commentersshlex.wordcharsshlex.whitespaceshlex.escapeshlex.quotesshlex.escapedquotesshlex.whitespace_splitshlex.infileshlex.instreamshlex.sourceshlex.debugshlex.linenoshlex.tokenshlex.eof
- 23.2.2. Parsing Rules
- 23.1.
- 24. Graphical User Interfaces with Tk
- 24.1.
Tkinter— Python interface to Tcl/Tk - 24.2.
ttk— Tk themed widgets- 24.2.1. Using Ttk
- 24.2.2. Ttk Widgets
- 24.2.3. Widget
- 24.2.4. Combobox
- 24.2.5. Notebook
- 24.2.6. Progressbar
- 24.2.7. Separator
- 24.2.8. Sizegrip
- 24.2.9. Treeview
- 24.2.9.1. Options
- 24.2.9.2. Item Options
- 24.2.9.3. Tag Options
- 24.2.9.4. Column Identifiers
- 24.2.9.5. Virtual Events
- 24.2.9.6. ttk.Treeview
TreeviewTreeview.bbox()Treeview.get_children()Treeview.set_children()Treeview.column()Treeview.delete()Treeview.detach()Treeview.exists()Treeview.focus()Treeview.heading()Treeview.identify()Treeview.identify_row()Treeview.identify_column()Treeview.identify_region()Treeview.identify_element()Treeview.index()Treeview.insert()Treeview.item()Treeview.move()Treeview.next()Treeview.parent()Treeview.prev()Treeview.reattach()Treeview.see()Treeview.selection()Treeview.selection_set()Treeview.selection_add()Treeview.selection_remove()Treeview.selection_toggle()Treeview.set()Treeview.tag_bind()Treeview.tag_configure()Treeview.tag_has()Treeview.xview()Treeview.yview()
- 24.2.10. Ttk Styling
- 24.3.
Tix— Extension widgets for Tk - 24.4.
ScrolledText— Scrolled Text Widget - 24.5.
turtle— Turtle graphics for Tk- 24.5.1. Introduction
- 24.5.2. Overview over available Turtle and Screen methods
- 24.5.3. Methods of RawTurtle/Turtle and corresponding functions
- 24.5.4. Methods of TurtleScreen/Screen and corresponding functions
- 24.5.5. The public classes of the module
turtle - 24.5.6. Help and configuration
- 24.5.7. Demo scripts
- 24.6. IDLE
- 24.6.1. Menus
- 24.6.1.1. File menu (Shell and Editor)
- 24.6.1.2. Edit menu (Shell and Editor)
- 24.6.1.3. Format menu (Editor window only)
- 24.6.1.4. Run menu (Editor window only)
- 24.6.1.5. Shell menu (Shell window only)
- 24.6.1.6. Debug menu (Shell window only)
- 24.6.1.7. Options menu (Shell and Editor)
- 24.6.1.8. Window menu (Shell and Editor)
- 24.6.1.9. Help menu (Shell and Editor)
- 24.6.1.10. Context Menus
- 24.6.2. Editing and navigation
- 24.6.3. Startup and code execution
- 24.6.4. Help and preferences
- 24.6.1. Menus
- 24.7. Other Graphical User Interface Packages
- 24.1.
- 25. Development Tools
- 25.1.
pydoc— Documentation generator and online help system - 25.2.
doctest— Test interactive Python examples- 25.2.1. Simple Usage: Checking Examples in Docstrings
- 25.2.2. Simple Usage: Checking Examples in a Text File
- 25.2.3. How It Works
- 25.2.4. Basic API
- 25.2.5. Unittest API
- 25.2.6. Advanced API
- 25.2.7. Debugging
- 25.2.8. Soapbox
- 25.3.
unittest— Unit testing framework- 25.3.1. Basic example
- 25.3.2. Command-Line Interface
- 25.3.3. Test Discovery
- 25.3.4. Organizing test code
- 25.3.5. Re-using old test code
- 25.3.6. Skipping tests and expected failures
- 25.3.7. Classes and functions
- 25.3.7.1. Test cases
TestCaseTestCase.setUp()TestCase.tearDown()TestCase.setUpClass()TestCase.tearDownClass()TestCase.run()TestCase.skipTest()TestCase.debug()TestCase.assertEqual()TestCase.assertNotEqual()TestCase.assertTrue()TestCase.assertFalse()TestCase.assertIs()TestCase.assertIsNot()TestCase.assertIsNone()TestCase.assertIsNotNone()TestCase.assertIn()TestCase.assertNotIn()TestCase.assertIsInstance()TestCase.assertNotIsInstance()TestCase.assertRaises()TestCase.assertRaisesRegexp()TestCase.assertAlmostEqual()TestCase.assertNotAlmostEqual()TestCase.assertGreater()TestCase.assertGreaterEqual()TestCase.assertLess()TestCase.assertLessEqual()TestCase.assertRegexpMatches()TestCase.assertNotRegexpMatches()TestCase.assertItemsEqual()TestCase.assertDictContainsSubset()TestCase.addTypeEqualityFunc()TestCase.assertMultiLineEqual()TestCase.assertSequenceEqual()TestCase.assertListEqual()TestCase.assertTupleEqual()TestCase.assertSetEqual()TestCase.assertDictEqual()TestCase.fail()TestCase.failureExceptionTestCase.longMessageTestCase.maxDiffTestCase.countTestCases()TestCase.defaultTestResult()TestCase.id()TestCase.shortDescription()TestCase.addCleanup()TestCase.doCleanups()
FunctionTestCase- 25.3.7.1.1. Deprecated aliases
- 25.3.7.2. Grouping tests
- 25.3.7.3. Loading and running tests
TestLoaderTestResultTestResult.errorsTestResult.failuresTestResult.skippedTestResult.expectedFailuresTestResult.unexpectedSuccessesTestResult.shouldStopTestResult.testsRunTestResult.bufferTestResult.failfastTestResult.wasSuccessful()TestResult.stop()TestResult.startTest()TestResult.stopTest()TestResult.startTestRun()TestResult.stopTestRun()TestResult.addError()TestResult.addFailure()TestResult.addSuccess()TestResult.addSkip()TestResult.addExpectedFailure()TestResult.addUnexpectedSuccess()
TextTestResultdefaultTestLoaderTextTestRunnermain()- 25.3.7.3.1. load_tests Protocol
- 25.3.7.1. Test cases
- 25.3.8. Class and Module Fixtures
- 25.3.9. Signal Handling
- 25.4. 2to3 - Automated Python 2 to 3 code translation
- 25.5.
test— Regression tests package for Python - 25.6.
test.support— Utility functions for testsTestFailedResourceDeniedverbosehave_unicodeis_jythonTESTFNTEST_HTTP_URLforget()is_resource_enabled()requires()findfile()run_unittest()check_warnings()check_py3k_warnings()captured_stdout()import_module()import_fresh_module()TransientResourceEnvironmentVarGuardEnvironmentVarGuard.set()EnvironmentVarGuard.unset()WarningsRecorder
- 25.1.
- 26. Debugging and Profiling
- 26.1.
bdb— Debugger frameworkBdbQuitBreakpointBdbBdb.canonic()Bdb.reset()Bdb.trace_dispatch()Bdb.dispatch_line()Bdb.dispatch_call()Bdb.dispatch_return()Bdb.dispatch_exception()Bdb.stop_here()Bdb.break_here()Bdb.break_anywhere()Bdb.user_call()Bdb.user_line()Bdb.user_return()Bdb.user_exception()Bdb.do_clear()Bdb.set_step()Bdb.set_next()Bdb.set_return()Bdb.set_until()Bdb.set_trace()Bdb.set_continue()Bdb.set_quit()Bdb.set_break()Bdb.clear_break()Bdb.clear_bpbynumber()Bdb.clear_all_file_breaks()Bdb.clear_all_breaks()Bdb.get_break()Bdb.get_breaks()Bdb.get_file_breaks()Bdb.get_all_breaks()Bdb.get_stack()Bdb.format_stack_entry()Bdb.run()Bdb.runeval()Bdb.runctx()Bdb.runcall()
checkfuncname()effective()set_trace()
- 26.2.
pdb— The Python Debugger - 26.3. Debugger Commands
- 26.4. The Python Profilers
- 26.5.
hotshot— High performance logging profiler - 26.6.
timeit— Measure execution time of small code snippets - 26.7.
trace— Trace or track Python statement execution
- 26.1.
- 27. Software Packaging and Distribution
- 28. Python Runtime Services
- 28.1.
sys— System-specific parameters and functionsargvbyteorderbuiltin_module_namescall_tracing()copyright_clear_type_cache()_current_frames()dllhandledisplayhook()dont_write_bytecodeexcepthook()__displayhook____excepthook__exc_info()exc_clear()exc_typeexc_valueexc_tracebackexec_prefixexecutableexit()exitfuncflagsfloat_infofloat_repr_stylegetcheckinterval()getdefaultencoding()getdlopenflags()getfilesystemencoding()getrefcount()getrecursionlimit()getsizeof()_getframe()getprofile()gettrace()getwindowsversion()hexversionlong_infolast_typelast_valuelast_tracebackmaxintmaxsizemaxunicodemeta_pathmodulespathpath_hookspath_importer_cacheplatformprefixps1ps2py3kwarningsetcheckinterval()setdefaultencoding()setdlopenflags()setprofile()setrecursionlimit()settrace()settscdump()stdinstdoutstderr__stdin____stdout____stderr__subversiontracebacklimitversionapi_versionversion_infowarnoptionswinver
- 28.2.
sysconfig— Provide access to Python’s configuration information - 28.3.
__builtin__— Built-in objects - 28.4.
future_builtins— Python 3 builtins - 28.5.
__main__— Top-level script environment - 28.6.
warnings— Warning control - 28.7.
contextlib— Utilities forwith-statement contexts - 28.8.
abc— Abstract Base Classes - 28.9.
atexit— Exit handlers - 28.10.
traceback— Print or retrieve a stack traceback - 28.11.
__future__— Future statement definitions - 28.12.
gc— Garbage Collector interface - 28.13.
inspect— Inspect live objects - 28.14.
site— Site-specific configuration hook - 28.15.
user— User-specific configuration hook - 28.16.
fpectl— Floating point exception control
- 28.1.
- 29. Custom Python Interpreters
- 30. Restricted Execution
- 31. Importing Modules
- 31.1.
imp— Access theimportinternalsget_magic()get_suffixes()find_module()load_module()new_module()lock_held()acquire_lock()release_lock()PY_SOURCEPY_COMPILEDC_EXTENSIONPKG_DIRECTORYC_BUILTINPY_FROZENSEARCH_ERRORinit_builtin()init_frozen()is_builtin()is_frozen()load_compiled()load_dynamic()load_source()NullImporter- 31.1.1. Examples
- 31.2.
importlib— Convenience wrappers for__import__() - 31.3.
imputil— Import utilities - 31.4.
zipimport— Import modules from Zip archives - 31.5.
pkgutil— Package extension utility - 31.6.
modulefinder— Find modules used by a script - 31.7.
runpy— Locating and executing Python modules
- 31.1.
- 32. Python Language Services
- 32.1.
parser— Access Python parse trees - 32.2.
ast— Abstract Syntax Trees - 32.3.
symtable— Access to the compiler’s symbol tables- 32.3.1. Generating Symbol Tables
- 32.3.2. Examining Symbol Tables
SymbolTableSymbolTable.get_type()SymbolTable.get_id()SymbolTable.get_name()SymbolTable.get_lineno()SymbolTable.is_optimized()SymbolTable.is_nested()SymbolTable.has_children()SymbolTable.has_exec()SymbolTable.has_import_star()SymbolTable.get_identifiers()SymbolTable.lookup()SymbolTable.get_symbols()SymbolTable.get_children()
FunctionClassSymbol
- 32.4.
symbol— Constants used with Python parse trees - 32.5.
token— Constants used with Python parse treestok_nameISTERMINAL()ISNONTERMINAL()ISEOF()ENDMARKERNAMENUMBERSTRINGNEWLINEINDENTDEDENTLPARRPARLSQBRSQBCOLONCOMMASEMIPLUSMINUSSTARSLASHVBARAMPERLESSGREATEREQUALDOTPERCENTBACKQUOTELBRACERBRACEEQEQUALNOTEQUALLESSEQUALGREATEREQUALTILDECIRCUMFLEXLEFTSHIFTRIGHTSHIFTDOUBLESTARPLUSEQUALMINEQUALSTAREQUALSLASHEQUALPERCENTEQUALAMPEREQUALVBAREQUALCIRCUMFLEXEQUALLEFTSHIFTEQUALRIGHTSHIFTEQUALDOUBLESTAREQUALDOUBLESLASHDOUBLESLASHEQUALATOPERRORTOKENN_TOKENSNT_OFFSET
- 32.6.
keyword— Testing for Python keywords - 32.7.
tokenize— Tokenizer for Python source - 32.8.
tabnanny— Detection of ambiguous indentation - 32.9.
pyclbr— Python class browser support - 32.10.
py_compile— Compile Python source files - 32.11.
compileall— Byte-compile Python libraries - 32.12.
dis— Disassembler for Python bytecode - 32.13.
pickletools— Tools for pickle developers
- 32.1.
- 33. Python compiler package
- 34. Miscellaneous Services
- 34.1.
formatter— Generic output formatting- 34.1.1. The Formatter Interface
AS_ISformatter.writerformatter.end_paragraph()formatter.add_line_break()formatter.add_hor_rule()formatter.add_flowing_data()formatter.add_literal_data()formatter.add_label_data()formatter.flush_softspace()formatter.push_alignment()formatter.pop_alignment()formatter.push_font()formatter.pop_font()formatter.push_margin()formatter.pop_margin()formatter.push_style()formatter.pop_style()formatter.set_spacing()formatter.assert_line_data()
- 34.1.2. Formatter Implementations
- 34.1.3. The Writer Interface
- 34.1.4. Writer Implementations
- 34.1.1. The Formatter Interface
- 34.1.
- 35. MS Windows Specific Services
- 35.1.
msilib— Read and write Microsoft Installer filesFCICreate()UuidCreate()OpenDatabase()CreateRecord()init_database()add_data()Binaryadd_tables()add_stream()gen_uuid()- 35.1.1. Database Objects
- 35.1.2. View Objects
- 35.1.3. Summary Information Objects
- 35.1.4. Record Objects
- 35.1.5. Errors
- 35.1.6. CAB Objects
- 35.1.7. Directory Objects
- 35.1.8. Features
- 35.1.9. GUI classes
- 35.1.10. Precomputed tables
- 35.2.
msvcrt— Useful routines from the MS VC++ runtime - 35.3.
_winreg— Windows registry accessCloseKey()ConnectRegistry()CreateKey()CreateKeyEx()DeleteKey()DeleteKeyEx()DeleteValue()EnumKey()EnumValue()ExpandEnvironmentStrings()FlushKey()LoadKey()OpenKey()OpenKeyEx()QueryInfoKey()QueryValue()QueryValueEx()SaveKey()SetValue()SetValueEx()DisableReflectionKey()EnableReflectionKey()QueryReflectionKey()- 35.3.1. Constants
- 35.3.2. Registry Handle Objects
- 35.4.
winsound— Sound-playing interface for Windows
- 35.1.
- 36. Unix Specific Services
- 36.1.
posix— The most common POSIX system calls - 36.2.
pwd— The password database - 36.3.
spwd— The shadow password database - 36.4.
grp— The group database - 36.5.
crypt— Function to check Unix passwords - 36.6.
dl— Call C functions in shared objects - 36.7.
termios— POSIX style tty control - 36.8.
tty— Terminal control functions - 36.9.
pty— Pseudo-terminal utilities - 36.10.
fcntl— Thefcntlandioctlsystem calls - 36.11.
pipes— Interface to shell pipelines - 36.12.
posixfile— File-like objects with locking support - 36.13.
resource— Resource usage information - 36.14.
nis— Interface to Sun’s NIS (Yellow Pages) - 36.15.
syslog— Unix syslog library routines - 36.16.
commands— Utilities for running commands
- 36.1.
- 37. Mac OS X specific services
- 37.1.
ic— Access to the Mac OS X Internet Config - 37.2.
MacOS— Access to Mac OS interpreter features - 37.3.
macostools— Convenience routines for file manipulation - 37.4.
findertools— The finder’s Apple Events interface - 37.5.
EasyDialogs— Basic Macintosh dialogs - 37.6.
FrameWork— Interactive application framework - 37.7.
autoGIL— Global Interpreter Lock handling in event loops - 37.8. Mac OS Toolbox Modules
- 37.8.1.
Carbon.AE— Apple Events - 37.8.2.
Carbon.AH— Apple Help - 37.8.3.
Carbon.App— Appearance Manager - 37.8.4.
Carbon.Appearance— Appearance Manager constants - 37.8.5.
Carbon.CF— Core Foundation - 37.8.6.
Carbon.CG— Core Graphics - 37.8.7.
Carbon.CarbonEvt— Carbon Event Manager - 37.8.8.
Carbon.CarbonEvents— Carbon Event Manager constants - 37.8.9.
Carbon.Cm— Component Manager - 37.8.10.
Carbon.Components— Component Manager constants - 37.8.11.
Carbon.ControlAccessor— Control Manager accssors - 37.8.12.
Carbon.Controls— Control Manager constants - 37.8.13.
Carbon.CoreFounation— CoreFounation constants - 37.8.14.
Carbon.CoreGraphics— CoreGraphics constants - 37.8.15.
Carbon.Ctl— Control Manager - 37.8.16.
Carbon.Dialogs— Dialog Manager constants - 37.8.17.
Carbon.Dlg— Dialog Manager - 37.8.18.
Carbon.Drag— Drag and Drop Manager - 37.8.19.
Carbon.Dragconst— Drag and Drop Manager constants - 37.8.20.
Carbon.Events— Event Manager constants - 37.8.21.
Carbon.Evt— Event Manager - 37.8.22.
Carbon.File— File Manager - 37.8.23.
Carbon.Files— File Manager constants - 37.8.24.
Carbon.Fm— Font Manager - 37.8.25.
Carbon.Folder— Folder Manager - 37.8.26.
Carbon.Folders— Folder Manager constants - 37.8.27.
Carbon.Fonts— Font Manager constants - 37.8.28.
Carbon.Help— Help Manager - 37.8.29.
Carbon.IBCarbon— Carbon InterfaceBuilder - 37.8.30.
Carbon.IBCarbonRuntime— Carbon InterfaceBuilder constants - 37.8.31.
Carbon.Icn— Carbon Icon Manager - 37.8.32.
Carbon.Icons— Carbon Icon Manager constants - 37.8.33.
Carbon.Launch— Carbon Launch Services - 37.8.34.
Carbon.LaunchServices— Carbon Launch Services constants - 37.8.35.
Carbon.List— List Manager - 37.8.36.
Carbon.Lists— List Manager constants - 37.8.37.
Carbon.MacHelp— Help Manager constants - 37.8.38.
Carbon.MediaDescr— Parsers and generators for Quicktime Media descriptors - 37.8.39.
Carbon.Menu— Menu Manager - 37.8.40.
Carbon.Menus— Menu Manager constants - 37.8.41.
Carbon.Mlte— MultiLingual Text Editor - 37.8.42.
Carbon.OSA— Carbon OSA Interface - 37.8.43.
Carbon.OSAconst— Carbon OSA Interface constants - 37.8.44.
Carbon.QDOffscreen— QuickDraw Offscreen constants - 37.8.45.
Carbon.Qd— QuickDraw - 37.8.46.
Carbon.Qdoffs— QuickDraw Offscreen - 37.8.47.
Carbon.Qt— QuickTime - 37.8.48.
Carbon.QuickDraw— QuickDraw constants - 37.8.49.
Carbon.QuickTime— QuickTime constants - 37.8.50.
Carbon.Res— Resource Manager and Handles - 37.8.51.
Carbon.Resources— Resource Manager and Handles constants - 37.8.52.
Carbon.Scrap— Scrap Manager - 37.8.53.
Carbon.Snd— Sound Manager - 37.8.54.
Carbon.Sound— Sound Manager constants - 37.8.55.
Carbon.TE— TextEdit - 37.8.56.
Carbon.TextEdit— TextEdit constants - 37.8.57.
Carbon.Win— Window Manager - 37.8.58.
Carbon.Windows— Window Manager constants
- 37.8.1.
- 37.9.
ColorPicker— Color selection dialog
- 37.1.
- 38. MacPython OSA Modules
- 39. SGI IRIX Specific Services
- 39.1.
al— Audio functions on the SGI - 39.2.
AL— Constants used with thealmodule - 39.3.
cd— CD-ROM access on SGI systems - 39.4.
fl— FORMS library for graphical user interfaces- 39.4.1. Functions Defined in Module
flmake_form()do_forms()check_forms()set_event_call_back()set_graphics_mode()get_rgbmode()show_message()show_question()show_choice()show_input()show_file_selector()get_directory()get_pattern()get_filename()qdevice()unqdevice()isqueued()qtest()qread()qreset()qenter()get_mouse()tie()color()mapcolor()getmcolor()
- 39.4.2. Form Objects
form.show_form()form.hide_form()form.redraw_form()form.set_form_position()form.freeze_form()form.unfreeze_form()form.activate_form()form.deactivate_form()form.bgn_group()form.end_group()form.find_first()form.find_last()form.add_box()form.add_text()form.add_clock()form.add_button()form.add_lightbutton()form.add_roundbutton()form.add_slider()form.add_valslider()form.add_dial()form.add_positioner()form.add_counter()form.add_input()form.add_menu()form.add_choice()form.add_browser()form.add_timer()
- 39.4.3. FORMS Objects
- 39.4.1. Functions Defined in Module
- 39.5.
FL— Constants used with theflmodule - 39.6.
flp— Functions for loading stored FORMS designs - 39.7.
fm— Font Manager interface - 39.8.
gl— Graphics Library interface - 39.9.
DEVICE— Constants used with theglmodule - 39.10.
GL— Constants used with theglmodule - 39.11.
imgfile— Support for SGI imglib files - 39.12.
jpeg— Read and write JPEG files
- 39.1.
- 40. SunOS Specific Services
- 41. Undocumented Modules
- 41.1. Miscellaneous useful utilities
- 41.2. Platform specific modules
- 41.3. Multimedia
- 41.4. Undocumented Mac OS modules
- 41.4.1.
applesingle— AppleSingle decoder - 41.4.2.
buildtools— Helper module for BuildApplet and Friends - 41.4.3.
cfmfile— Code Fragment Resource module - 41.4.4.
icopen— Internet Config replacement foropen() - 41.4.5.
macerrors— Mac OS Errors - 41.4.6.
macresource— Locate script resources - 41.4.7.
Nav— NavServices calls - 41.4.8.
PixMapWrapper— Wrapper for PixMap objects - 41.4.9.
videoreader— Read QuickTime movies - 41.4.10.
W— Widgets built onFrameWork
- 41.4.1.
- 41.5. Obsolete
- 41.6. SGI-specific Extension modules
- Extending and Embedding the Python Interpreter
- 1. Extending Python with C or C++
- 1.1. A Simple Example
- 1.2. Intermezzo: Errors and Exceptions
- 1.3. Back to the Example
- 1.4. The Module’s Method Table and Initialization Function
- 1.5. Compilation and Linkage
- 1.6. Calling Python Functions from C
- 1.7. Extracting Parameters in Extension Functions
- 1.8. Keyword Parameters for Extension Functions
- 1.9. Building Arbitrary Values
- 1.10. Reference Counts
- 1.11. Writing Extensions in C++
- 1.12. Providing a C API for an Extension Module
- 2. Defining New Types
- 3. Building C and C++ Extensions with distutils
- 4. Building C and C++ Extensions on Windows
- 5. Embedding Python in Another Application
- 1. Extending Python with C or C++
- Python/C API Reference Manual
- Introduction
- The Very High Level Layer
- Reference Counting
- Exception Handling
- Utilities
- Abstract Objects Layer
- Concrete Objects Layer
- Initialization, Finalization, and Threads
- Memory Management
- Object Implementation Support
- Allocating Objects on the Heap
- Common Object Structures
- Type Objects
Py_TPFLAGS_HAVE_GETCHARBUFFERPy_TPFLAGS_HAVE_SEQUENCE_INPy_TPFLAGS_GCPy_TPFLAGS_HAVE_INPLACEOPSPy_TPFLAGS_CHECKTYPESPy_TPFLAGS_HAVE_RICHCOMPAREPy_TPFLAGS_HAVE_WEAKREFSPy_TPFLAGS_HAVE_ITERPy_TPFLAGS_HAVE_CLASSPy_TPFLAGS_HEAPTYPEPy_TPFLAGS_BASETYPEPy_TPFLAGS_READYPy_TPFLAGS_READYINGPy_TPFLAGS_HAVE_GCPy_TPFLAGS_DEFAULT
- Number Object Structures
- Mapping Object Structures
- Sequence Object Structures
- Buffer Object Structures
- Supporting Cyclic Garbage Collection
- Distributing Python Modules
- Installing Python Modules
- Python HOWTOs
- Porting Python 2 Code to Python 3
- The Short Explanation
- Details
- Drop support for Python 2.6 and older
- Make sure you specify the proper version support in your
setup.pyfile - Have good test coverage
- Learn the differences between Python 2 & 3
- Update your code
- Prevent compatibility regressions
- Check which dependencies block your transition
- Update your
setup.pyfile to denote Python 3 compatibility - Use continuous integration to stay compatible
- Consider using optional static type checking
- Porting Extension Modules to Python 3
- Curses Programming with Python
- Descriptor HowTo Guide
- Idioms and Anti-Idioms in Python
- Functional Programming HOWTO
- Logging HOWTO
- Logging Cookbook
- Using logging in multiple modules
- Logging from multiple threads
- Multiple handlers and formatters
- Logging to multiple destinations
- Configuration server example
- Sending and receiving logging events across a network
- Adding contextual information to your logging output
- Logging to a single file from multiple processes
- Using file rotation
- An example dictionary-based configuration
- Inserting a BOM into messages sent to a SysLogHandler
- Implementing structured logging
- Customizing handlers with
dictConfig() - Configuring filters with
dictConfig() - Customized exception formatting
- Speaking logging messages
- Buffering logging messages and outputting them conditionally
- Formatting times using UTC (GMT) via configuration
- Using a context manager for selective logging
- Regular Expression HOWTO
- Socket Programming HOWTO
- Sorting HOW TO
- Unicode HOWTO
- HOWTO Fetch Internet Resources Using urllib2
- HOWTO Use Python in the web
- Argparse Tutorial
- Porting Python 2 Code to Python 3
- Python Frequently Asked Questions
- General Python FAQ
- Programming FAQ
- Design and History FAQ
- Why does Python use indentation for grouping of statements?
- Why am I getting strange results with simple arithmetic operations?
- Why are floating point calculations so inaccurate?
- Why are Python strings immutable?
- Why must ‘self’ be used explicitly in method definitions and calls?
- Why can’t I use an assignment in an expression?
- Why does Python use methods for some functionality (e.g. list.index()) but functions for other (e.g. len(list))?
- Why is join() a string method instead of a list or tuple method?
- How fast are exceptions?
- Why isn’t there a switch or case statement in Python?
- Can’t you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?
- Why can’t lambda expressions contain statements?
- Can Python be compiled to machine code, C or some other language?
- How does Python manage memory?
- Why isn’t all memory freed when Python exits?
- Why are there separate tuple and list data types?
- How are lists implemented in CPython?
- How are dictionaries implemented in CPython?
- Why must dictionary keys be immutable?
- Why doesn’t list.sort() return the sorted list?
- How do you specify and enforce an interface spec in Python?
- Why is there no goto?
- Why can’t raw strings (r-strings) end with a backslash?
- Why doesn’t Python have a “with” statement for attribute assignments?
- Why are colons required for the if/while/def/class statements?
- Why does Python allow commas at the end of lists and tuples?
- Library and Extension FAQ
- Extending/Embedding FAQ
- Can I create my own functions in C?
- Can I create my own functions in C++?
- Writing C is hard; are there any alternatives?
- How can I execute arbitrary Python statements from C?
- How can I evaluate an arbitrary Python expression from C?
- How do I extract C values from a Python object?
- How do I use Py_BuildValue() to create a tuple of arbitrary length?
- How do I call an object’s method from C?
- How do I catch the output from PyErr_Print() (or anything that prints to stdout/stderr)?
- How do I access a module written in Python from C?
- How do I interface to C++ objects from Python?
- I added a module using the Setup file and the make fails; why?
- How do I debug an extension?
- I want to compile a Python module on my Linux system, but some files are missing. Why?
- What does “SystemError: _PyImport_FixupExtension: module yourmodule not loaded” mean?
- How do I tell “incomplete input” from “invalid input”?
- How do I find undefined g++ symbols __builtin_new or __pure_virtual?
- Can I create an object class with some methods implemented in C and others in Python (e.g. through inheritance)?
- When importing module X, why do I get “undefined symbol: PyUnicodeUCS2*”?
- Python on Windows FAQ
- How do I run a Python program under Windows?
- How do I make Python scripts executable?
- Why does Python sometimes take so long to start?
- How do I make an executable from a Python script?
- Is a
*.pydfile the same as a DLL? - How can I embed Python into a Windows application?
- How do I keep editors from inserting tabs into my Python source?
- How do I check for a keypress without blocking?
- How do I emulate os.kill() in Windows?
- How do I extract the downloaded documentation on Windows?
- Graphic User Interface FAQ
- “Why is Python Installed on my Computer?” FAQ
- Glossary
- About these documents
- Reporting Bugs
- Copyright
- History and License
