The Python Library Reference - University of Idaho

The Python Library Reference

Release 3.2.3

Guido van Rossum Fred L. Drake, Jr., editor

June 18, 2012

Python Software Foundation Email: docs@

CONTENTS

1 Introduction

3

2 Built-in Functions

5

3 Built-in Constants

25

3.1 Constants added by the site module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4 Built-in Types

27

4.1 Truth Value Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4.2 Boolean Operations -- and, or, not . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4.3 Comparisons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.4 Numeric Types -- int, float, complex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.5 Iterator Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

4.6 Sequence Types -- str, bytes, bytearray, list, tuple, range . . . . . . . . . . . . . . . 35

4.7 Set Types -- set, frozenset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

4.8 Mapping Types -- dict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

4.9 memoryview type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.10 Context Manager Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.11 Other Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.12 Special Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

5 Built-in Exceptions

59

5.1 Exception hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

6 String Services

65

6.1 string -- Common string operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

6.2 re -- Regular expression operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

6.3 struct -- Interpret bytes as packed binary data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

6.4 difflib -- Helpers for computing deltas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

6.5 textwrap -- Text wrapping and filling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

6.6 codecs -- Codec registry and base classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

6.7 unicodedata -- Unicode Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

6.8 stringprep -- Internet String Preparation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

7 Data Types

125

7.1 datetime -- Basic date and time types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

7.2 calendar -- General calendar-related functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

7.3 collections -- Container datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

7.4 heapq -- Heap queue algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

7.5 bisect -- Array bisection algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

i

7.6 array -- Efficient arrays of numeric values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 7.7 sched -- Event scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 7.8 queue -- A synchronized queue class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 7.9 weakref -- Weak references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 7.10 types -- Names for built-in types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 7.11 copy -- Shallow and deep copy operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 7.12 pprint -- Data pretty printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 7.13 reprlib -- Alternate repr() implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

8 Numeric and Mathematical Modules

195

8.1 numbers -- Numeric abstract base classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

8.2 math -- Mathematical functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

8.3 cmath -- Mathematical functions for complex numbers . . . . . . . . . . . . . . . . . . . . . . . . 202

8.4 decimal -- Decimal fixed point and floating point arithmetic . . . . . . . . . . . . . . . . . . . . 205

8.5 fractions -- Rational numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

8.6 random -- Generate pseudo-random numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

9 Functional Programming Modules

237

9.1 itertools -- Functions creating iterators for efficient looping . . . . . . . . . . . . . . . . . . . 237

9.2 functools -- Higher-order functions and operations on callable objects . . . . . . . . . . . . . . 250

9.3 operator -- Standard operators as functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

10 File and Directory Access

261

10.1 os.path -- Common pathname manipulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

10.2 fileinput -- Iterate over lines from multiple input streams . . . . . . . . . . . . . . . . . . . . . 264

10.3 stat -- Interpreting stat() results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

10.4 filecmp -- File and Directory Comparisons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

10.5 tempfile -- Generate temporary files and directories . . . . . . . . . . . . . . . . . . . . . . . . 272

10.6 glob -- Unix style pathname pattern expansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

10.7 fnmatch -- Unix filename pattern matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

10.8 linecache -- Random access to text lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

10.9 shutil -- High-level file operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

10.10 macpath -- Mac OS 9 path manipulation functions . . . . . . . . . . . . . . . . . . . . . . . . . . 283

11 Data Persistence

285

11.1 pickle -- Python object serialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

11.2 copyreg -- Register pickle support functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

11.3 shelve -- Python object persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

11.4 marshal -- Internal Python object serialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

11.5 dbm -- Interfaces to Unix "databases" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

11.6 sqlite3 -- DB-API 2.0 interface for SQLite databases . . . . . . . . . . . . . . . . . . . . . . . 303

12 Data Compression and Archiving

323

12.1 zlib -- Compression compatible with gzip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

12.2 gzip -- Support for gzip files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

12.3 bz2 -- Compression compatible with bzip2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

12.4 zipfile -- Work with ZIP archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

12.5 tarfile -- Read and write tar archive files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

13 File Formats

343

13.1 csv -- CSV File Reading and Writing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

13.2 configparser -- Configuration file parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

13.3 netrc -- netrc file processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

13.4 xdrlib -- Encode and decode XDR data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

13.5 plistlib -- Generate and parse Mac OS X .plist files . . . . . . . . . . . . . . . . . . . . . . 369

ii

14 Cryptographic Services

371

14.1 hashlib -- Secure hashes and message digests . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

14.2 hmac -- Keyed-Hashing for Message Authentication . . . . . . . . . . . . . . . . . . . . . . . . . 373

15 Generic Operating System Services

375

15.1 os -- Miscellaneous operating system interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

15.2 io -- Core tools for working with streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

15.3 time -- Time access and conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

15.4 argparse -- Parser for command-line options, arguments and sub-commands . . . . . . . . . . . 418

15.5 optparse -- Parser for command line options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

15.6 getopt -- C-style parser for command line options . . . . . . . . . . . . . . . . . . . . . . . . . . 471

15.7 logging -- Logging facility for Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

15.8 logging.config -- Logging configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

15.9 logging.handlers -- Logging handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

15.10 getpass -- Portable password input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

15.11 curses -- Terminal handling for character-cell displays . . . . . . . . . . . . . . . . . . . . . . . 506

15.12 curses.textpad -- Text input widget for curses programs . . . . . . . . . . . . . . . . . . . . . 522

15.13 curses.ascii -- Utilities for ASCII characters . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

15.14 curses.panel -- A panel stack extension for curses . . . . . . . . . . . . . . . . . . . . . . . . 525

15.15 platform -- Access to underlying platform's identifying data . . . . . . . . . . . . . . . . . . . . 527

15.16 errno -- Standard errno system symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530

15.17 ctypes -- A foreign function library for Python . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

16 Optional Operating System Services

569

16.1 select -- Waiting for I/O completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

16.2 threading -- Thread-based parallelism . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574

16.3 multiprocessing -- Process-based parallelism . . . . . . . . . . . . . . . . . . . . . . . . . . 585

16.4 concurrent.futures -- Launching parallel tasks . . . . . . . . . . . . . . . . . . . . . . . . . 635

16.5 mmap -- Memory-mapped file support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640

16.6 readline -- GNU readline interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643

16.7 rlcompleter -- Completion function for GNU readline . . . . . . . . . . . . . . . . . . . . . . 646

16.8 dummy_threading -- Drop-in replacement for the threading module . . . . . . . . . . . . . 647

16.9 _thread -- Low-level threading API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647

16.10 _dummy_thread -- Drop-in replacement for the _thread module . . . . . . . . . . . . . . . . 649

17 Interprocess Communication and Networking

651

17.1 subprocess -- Subprocess management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651

17.2 socket -- Low-level networking interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663

17.3 ssl -- TLS/SSL wrapper for socket objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675

17.4 signal -- Set handlers for asynchronous events . . . . . . . . . . . . . . . . . . . . . . . . . . . 689

17.5 asyncore -- Asynchronous socket handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692

17.6 asynchat -- Asynchronous socket command/response handler . . . . . . . . . . . . . . . . . . . 696

18 Internet Data Handling

701

18.1 email -- An email and MIME handling package . . . . . . . . . . . . . . . . . . . . . . . . . . . 701

18.2 json -- JSON encoder and decoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733

18.3 mailcap -- Mailcap file handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739

18.4 mailbox -- Manipulate mailboxes in various formats . . . . . . . . . . . . . . . . . . . . . . . . . 740

18.5 mimetypes -- Map filenames to MIME types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756

18.6 base64 -- RFC 3548: Base16, Base32, Base64 Data Encodings . . . . . . . . . . . . . . . . . . . 759

18.7 binhex -- Encode and decode binhex4 files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761

18.8 binascii -- Convert between binary and ASCII . . . . . . . . . . . . . . . . . . . . . . . . . . . 762

18.9 quopri -- Encode and decode MIME quoted-printable data . . . . . . . . . . . . . . . . . . . . . 763

18.10 uu -- Encode and decode uuencode files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764

iii

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download